itkPathConstIterator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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:

  typedef PathConstIterator Self;

  itkStaticConstMacro(ImageIteratorDimension, unsigned int,
                      TImage::ImageDimension);

  typedef typename TImage::IndexType      IndexType;

  typedef typename TImage::OffsetType      OffsetType;

  typedef typename TImage::SizeType      SizeType;

  typedef typename TImage::RegionType RegionType;

  typedef typename TImage::SpacingType SpacingType;

  typedef typename TImage::PointType PointType;

  typedef TImage ImageType;

  typedef typename TImage::PixelContainer  PixelContainer;
  typedef typename PixelContainer::Pointer PixelContainerPointer;

  typedef typename TImage::InternalPixelType InternalPixelType;

  typedef typename TImage::PixelType PixelType;

  typedef typename TImage::AccessorType AccessorType;

  typedef TPath PathType;

  typedef typename PathType::InputType PathInputType;

  typedef typename PathType::OutputType PathOutputType;

  itkTypeMacroNoParent(PathConstIterator);

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

  const PathInputType GetPathPosition()
  {
    return m_CurrentPathPosition;
  }

  const IndexType GetIndex()
  {
    return m_CurrentImageIndex;
  }

  const PixelType & Get(void) const
  {
    return m_Image->GetPixel(m_CurrentImageIndex);
  }

  bool IsAtEnd()
  {
    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() {}

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