otbPolyLineImageConstIterator.h

Go to the documentation of this file.

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

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt 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 __otbPolyLineImageConstIterator_h
#define __otbPolyLineImageConstIterator_h

#include "itkIndex.h"
#include "itkImage.h"
#include "itkLineIterator.h"

namespace otb
{
template <class TImage, class TPath>
class ITK_EXPORT PolyLineImageConstIterator
{
public:
  typedef PolyLineImageConstIterator 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 TPath                                  PathType;
  typedef typename PathType::VertexType          VertexType;
  typedef typename PathType::VertexListType      VertexListType;
  typedef typename VertexListType::ConstIterator VertexIteratorType;
  typedef itk::LineIterator<ImageType>           InternalImageIteratorType;
  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;

  itkTypeMacro(PolyLineImageConstIterator, None);

  static unsigned int GetImageIteratorDimension()
  {
    return TImage::ImageDimension;
  }
  const IndexType GetIndex()
  {
    return m_InternalImageIterator.GetIndex();
  }
  const PixelType& Get(void) const
  {
    return m_InternalImageIterator.Get();
  }
  bool IsAtEnd()
  {
    return (m_InternalVertexIterator == m_Path->GetVertexList()->End())
           && m_InternalImageIterator.IsAtEnd();
  }
  void GoToBegin();
  void operator ++();
  Self& operator =(const Self& it);
  PolyLineImageConstIterator(const ImageType * imagePtr, const PathType * pathPtr);
  virtual ~PolyLineImageConstIterator() {}

protected: //made protected so other iterators can access

  typename ImageType::ConstWeakPointer m_Image;

  typename PathType::ConstPointer m_Path;
  InternalImageIteratorType m_InternalImageIterator;
  VertexIteratorType        m_InternalVertexIterator;
};

} // End namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbPolyLineImageConstIterator.txx"
#endif

#endif