itkPathConstIterator.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 itkPathConstIterator_h
#define itkPathConstIterator_h
 
#include "itkImage.h"
#include "itkPath.h"
 
namespace itk
{
template <typename TImage, typename TPath>
class ITK_TEMPLATE_EXPORT PathConstIterator
{
public:
  using Self = PathConstIterator;

  static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension;

  using IndexType = typename TImage::IndexType;

  using OffsetType = typename TImage::OffsetType;

  using SizeType = typename TImage::SizeType;

  using RegionType = typename TImage::RegionType;

  using SpacingType = typename TImage::SpacingType;

  using PointType = typename TImage::PointType;

  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 PathType = TPath;

  using PathInputType = typename PathType::InputType;

  using PathOutputType = typename PathType::OutputType;

  itkVirtualGetNameOfClassMacro(PathConstIterator);

  static unsigned int
  GetImageIteratorDimension()
  {
    return TImage::ImageDimension;
  }

  const PathInputType
  GetPathPosition()
  {
    return m_CurrentPathPosition;
  }

  const IndexType
  GetIndex()
  {
    return m_CurrentImageIndex;
  }

  [[nodiscard]] const PixelType &
  Get() const
  {
    return m_Image->GetPixel(m_CurrentImageIndex);
  }

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

  inline virtual void
  VisitStartIndexAsLastIndexIfClosed(bool flag)
  {
    m_VisitStartIndexAsLastIndexIfClosed = flag;
  }

  void
  GoToBegin();

  void
  operator++();

  Self &
  operator=(const Self & it);

  PathConstIterator(const ImageType * imagePtr, const PathType * pathPtr);

  virtual ~PathConstIterator() = default;
 
protected: // made protected so other iterators can access
  // This "constant" is initialized in the constructor
  OffsetType m_ZeroOffset{}; // = 0 for all dimensions

  typename ImageType::ConstWeakPointer m_Image{};

  typename PathType::ConstPointer m_Path{};

  RegionType m_Region{};

  PointType m_ImageOrigin{};

  SpacingType m_ImageSpacing{};

  const SizeValueType * m_ImageSize{};

  bool m_VisitStartIndexAsLastIndexIfClosed{};

  bool m_IsAtEnd{};

  PathInputType m_CurrentPathPosition{};

  IndexType m_CurrentImageIndex{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPathConstIterator.hxx"
#endif
 
#endif