itkReflectiveImageRegionConstIterator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkReflectiveImageRegionConstIterator.h,v $
  Language:  C++
  Date:      $Date: 2002/09/25 06:07:11 $
  Version:   $Revision: 1.1 $

  Copyright (c) 2002 Insight 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 __itkReflectiveImageRegionConstIterator_h
#define __itkReflectiveImageRegionConstIterator_h

#include "itkImageConstIteratorWithIndex.h"

namespace itk
{

/* \class ReflectiveImageRegionConstIterator
 * \brief Multi-dimensional image iterator which only walks a region.
 * 
 * ReflectiveImageRegionConstIterator is a templated class to represent a
 * multi-dimensional iterator. ReflectiveImageRegionConstIterator is templated
 * over the image type.  ReflectiveImageRegionConstIterator is constrained to
 * walk only within the specified region.
 *
 * ReflectiveImageRegionConstIterator will perform two passes over the image
 * along each dimension. It is useful for algorithms that require to 
 * go back and forth (once) over the data. 
 *
 * \sa DanielssonDistanceMapImageFilter
 *
 * \ingroup Iterators 
 */
template<typename TImage>
class ReflectiveImageRegionConstIterator : public ImageConstIteratorWithIndex<TImage>
{
public:
  typedef ReflectiveImageRegionConstIterator Self;
  typedef ImageConstIteratorWithIndex<TImage>  Superclass;

  typedef typename TImage::IndexType  IndexType;

  typedef TImage ImageType;

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

  typedef typename TImage::RegionType RegionType;

  ReflectiveImageRegionConstIterator() ;
  
  ~ReflectiveImageRegionConstIterator() {};
  
  ReflectiveImageRegionConstIterator(TImage *ptr,
                            const RegionType& region);
   

  ReflectiveImageRegionConstIterator( const ImageConstIteratorWithIndex<TImage> &it)
    { this->ImageConstIteratorWithIndex<TImage>::operator=(it); }

  bool IsReflected(unsigned int) const;
  Self & operator++();

  void GoToBegin(void);

private:
  bool m_IsFirstPass[TImage::ImageDimension];
  
};

} // end namespace itk

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

#endif

---