itkReflectiveImageRegionConstIterator.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 itkReflectiveImageRegionConstIterator_h
#define itkReflectiveImageRegionConstIterator_h
 
#include "itkImageConstIteratorWithIndex.h"
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ReflectiveImageRegionConstIterator : public ImageConstIteratorWithIndex<TImage>
{
public:
  using Self = ReflectiveImageRegionConstIterator;
  using Superclass = ImageConstIteratorWithIndex<TImage>;

  using IndexType = typename TImage::IndexType;

  using ImageType = TImage;

  using PixelContainer = typename TImage::PixelContainer;
  using PixelContainerPointer = typename PixelContainer::Pointer;

  using RegionType = typename TImage::RegionType;
  using SizeType = typename TImage::SizeType;
  using SizeValueType = typename TImage::SizeValueType;

  using OffsetType = typename TImage::OffsetType;
  using OffsetValueType = typename OffsetType::OffsetValueType;

  ReflectiveImageRegionConstIterator();

  ~ReflectiveImageRegionConstIterator() override = default;

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

  ReflectiveImageRegionConstIterator(const Self & it);

  ReflectiveImageRegionConstIterator(const ImageConstIteratorWithIndex<TImage> & it);

  Self &
  operator=(const Self & it);
 
  bool
  IsReflected(unsigned int) const;

  Self &
  operator++();

  void
  GoToBegin();

  bool
  IsAtBegin() const
  {
    return !this->m_Remaining;
  }

  void
  SetBeginOffset(const OffsetType & offset)
  {
    m_BeginOffset = offset;
  }

  void
  SetEndOffset(const OffsetType & offset)
  {
    m_EndOffset = offset;
  }

  OffsetType
  GetBeginOffset(const OffsetType &)
  {
    return m_BeginOffset;
  }

  OffsetType
  GetEndOffset(const OffsetType &)
  {
    return m_EndOffset;
  }

  void
  FillOffsets(const OffsetValueType & value);
 
private:
  bool       m_IsFirstPass[TImage::ImageDimension]{};
  OffsetType m_BeginOffset{};
  OffsetType m_EndOffset{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkReflectiveImageRegionConstIterator.hxx"
#endif
 
#endif