itkPathConstIterator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkPathConstIterator.h,v $
  Language:  C++
  Date:      $Date: 2004-11-01 21:16:31 $
  Version:   $Revision: 1.7 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkPathConstIterator_h
#define __itkPathConstIterator_h

#include "itkIndex.h"
#include "itkImage.h"
#include "itkPath.h"

namespace itk
{

template<class TImage, class TPath>
class ITK_EXPORT PathConstIterator
{
public:

  typedef PathConstIterator Self;

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

  typedef typename TImage::IndexType          IndexType;
  typedef typename TImage::IndexValueType     IndexValueType;

  typedef typename TImage::OffsetType         OffsetType;
  typedef typename TImage::OffsetValueType    OffsetValueType;

  typedef typename TImage::SizeType           SizeType;
  typedef typename TImage::SizeValueType      SizeValueType;

  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;

  itkTypeMacro(PathConstIterator, None);

  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 unsigned long int* m_ImageSize;

  bool m_VisitStartIndexAsLastIndexIfClosed;

  bool m_IsAtEnd;

  PathInputType m_CurrentPathPosition;

  IndexType m_CurrentImageIndex;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPathConstIterator.txx"
#endif

#endif