itkImageRegionExclusionConstIteratorWithIndex.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkImageRegionExclusionConstIteratorWithIndex_h
#define itkImageRegionExclusionConstIteratorWithIndex_h
 
#include "itkImageRegionConstIteratorWithIndex.h"
#include <type_traits> // For remove_const_t.
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ImageRegionExclusionConstIteratorWithIndex : public ImageRegionConstIteratorWithIndex<TImage>
{
public:
  using Self = ImageRegionExclusionConstIteratorWithIndex;
  using Superclass = ImageRegionConstIteratorWithIndex<TImage>;

  using typename Superclass::IndexType;
  using typename Superclass::SizeType;
  using typename Superclass::OffsetType;
  using typename Superclass::RegionType;
  using typename Superclass::ImageType;
  using typename Superclass::PixelContainer;
  using typename Superclass::PixelContainerPointer;
  using typename Superclass::InternalPixelType;
  using typename Superclass::PixelType;
  using typename Superclass::AccessorType;

  ImageRegionExclusionConstIteratorWithIndex() = default;

  ImageRegionExclusionConstIteratorWithIndex(const TImage * ptr, const RegionType & region);

  ImageRegionExclusionConstIteratorWithIndex(const Superclass & it);

  Self &
  operator++();

  Self &
  operator--();

  void
  SetExclusionRegion(const RegionType & region);

  void
  SetExclusionRegionToInsetRegion();

  void
  GoToBegin();

  void
  GoToReverseBegin();
 
private:
  RegionType m_ExclusionRegion;
 
  IndexType m_ExclusionBegin;
  IndexType m_ExclusionEnd;
};
 
// Deduction guide for class template argument deduction (CTAD).
template <typename TImage>
ImageRegionExclusionConstIteratorWithIndex(SmartPointer<TImage>, const typename TImage::RegionType &)
  -> ImageRegionExclusionConstIteratorWithIndex<std::remove_const_t<TImage>>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageRegionExclusionConstIteratorWithIndex.hxx"
#endif
 
#endif