itkImageConstIteratorWithIndex.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 itkImageConstIteratorWithIndex_h
#define itkImageConstIteratorWithIndex_h
 
#include "itkIndex.h"
#include "itkImage.h"
#include <memory>
#include <type_traits> // For remove_const_t.
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ImageConstIteratorWithIndex
{
public:
  using Self = ImageConstIteratorWithIndex;

  static constexpr unsigned int ImageDimension = TImage::ImageDimension;

  using IndexType = typename TImage::IndexType;
  using IndexValueType = typename IndexType::IndexValueType;

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

  using RegionType = typename TImage::RegionType;

  using ImageType = TImage;

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

  using InternalPixelType = typename TImage::InternalPixelType;

  using PixelType = typename TImage::PixelType;

  using AccessorType = typename TImage::AccessorType;
  using AccessorFunctorType = typename TImage::AccessorFunctorType;

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

  ImageConstIteratorWithIndex() = default;

  ImageConstIteratorWithIndex(const Self & it);

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

  virtual ~ImageConstIteratorWithIndex() = default;

  Self &
  operator=(const Self & it);

  static constexpr unsigned int
  GetImageDimension()
  {
    return ImageDimension;
  }

  bool
  operator==(const Self & it) const
  {
    // two iterators are the same if they "point to" the same memory location
    return (m_Position) == (it.m_Position);
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);

  bool
  operator<=(const Self & it) const
  {
    // an iterator is "less than" another if it "points to" a lower
    // memory location
    return (m_Position) <= (it.m_Position);
  }

  bool
  operator<(const Self & it) const
  {
    // an iterator is "less than" another if it "points to" a lower
    // memory location
    return (m_Position) < (it.m_Position);
  }

  bool
  operator>=(const Self & it) const
  {
    // an iterator is "greater than" another if it "points to" a higher
    // memory location
    return (m_Position) >= (it.m_Position);
  }

  bool
  operator>(const Self & it) const
  {
    // an iterator is "greater than" another if it "points to" a higher
    // memory location
    return (m_Position) > (it.m_Position);
  }

  [[nodiscard]] const IndexType &
  GetIndex() const
  {
    return m_PositionIndex;
  }

  [[nodiscard]] const RegionType &
  GetRegion() const
  {
    return m_Region;
  }

  void
  SetIndex(const IndexType & ind)
  {
    m_Position = m_Image->GetBufferPointer() + m_Image->ComputeOffset(ind);
    m_PositionIndex = ind;
  }

  [[nodiscard]] PixelType
  Get() const
  {
    return m_PixelAccessorFunctor.Get(*m_Position);
  }

  [[nodiscard]] const PixelType &
  Value() const
  {
    return *m_Position;
  }

  void
  GoToBegin();

  void
  GoToReverseBegin();

  [[nodiscard]] bool
  IsAtReverseEnd() const
  {
    return !m_Remaining;
  }

  [[nodiscard]] bool
  IsAtEnd() const
  {
    return !m_Remaining;
  }

  bool
  Remaining()
  {
    return m_Remaining;
  }
 
protected: // made protected so other iterators can access
  typename TImage::ConstWeakPointer m_Image{};
 
  IndexType m_PositionIndex{ { 0 } }; // Index where we currently are
  IndexType m_BeginIndex{ { 0 } };    // Index to start iterating over
  IndexType m_EndIndex{ { 0 } };      // Index to finish iterating:
                                      // one pixel past the end of each
                                      // row, col, slice, etc....
 
  RegionType m_Region{}; // region to iterate over
 
  OffsetValueType m_OffsetTable[ImageDimension + 1]{};
 
  const InternalPixelType * m_Position{ nullptr };
  const InternalPixelType * m_Begin{ nullptr };
  const InternalPixelType * m_End{ nullptr };
 
  bool m_Remaining{ false };
 
  AccessorType        m_PixelAccessor{};
  AccessorFunctorType m_PixelAccessorFunctor{};
};
 
// Deduction guide for class template argument deduction (CTAD).
template <typename TImage>
ImageConstIteratorWithIndex(SmartPointer<TImage>, const typename TImage::RegionType &)
  -> ImageConstIteratorWithIndex<std::remove_const_t<TImage>>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageConstIteratorWithIndex.hxx"
#endif
 
#endif