itkImageRegionConstIterator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageRegionConstIterator.h,v $
  Language:  C++
  Date:      $Date: 2002/09/30 12:43:58 $
  Version:   $Revision: 1.8 $

  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 __itkImageRegionConstIterator_h
#define __itkImageRegionConstIterator_h

#include "itkImageConstIterator.h"
#include "itkImageIterator.h"

namespace itk
{

template<typename TImage>
class ImageRegionConstIterator : public ImageConstIterator<TImage>
{
public:
  typedef ImageRegionConstIterator Self;
  typedef ImageConstIterator<TImage>  Superclass;
  
  itkStaticConstMacro(ImageIteratorDimension, unsigned int,
                      Superclass::ImageIteratorDimension);

  typedef typename Superclass::IndexType IndexType;

  typedef typename Superclass::SizeType SizeType;

  typedef typename Superclass::RegionType   RegionType;

  typedef typename Superclass::ImageType ImageType;

  typedef typename Superclass::PixelContainer         PixelContainer;
  typedef typename Superclass::PixelContainerPointer  PixelContainerPointer;
  
  typedef typename Superclass::InternalPixelType   InternalPixelType;

  typedef typename Superclass::PixelType   PixelType;

  typedef typename Superclass::AccessorType     AccessorType;

  itkTypeMacro(ImageRegionConstIterator, ImageIterator);

  ImageRegionConstIterator() : ImageConstIterator<TImage>()
  {
    m_SpanBeginOffset = 0;
    m_SpanEndOffset = 0;
  }
  
  ImageRegionConstIterator(const ImageType *ptr,
                      const RegionType &region)
    : ImageConstIterator<TImage>(ptr, region)
  {
    m_SpanBeginOffset = m_BeginOffset;
    m_SpanEndOffset   = m_BeginOffset + static_cast<long>(m_Region.GetSize()[0]);
  }

  ImageRegionConstIterator( const ImageIterator<TImage> &it)
  {
    this->ImageIterator<TImage>::operator=(it);
    IndexType ind = this->GetIndex();
    m_SpanEndOffset = m_Offset + static_cast<long>(m_Region.GetSize()[0]) 
      - (ind[0] - m_Region.GetIndex()[0]);
    m_SpanBeginOffset = m_SpanEndOffset
      - static_cast<long>(m_Region.GetSize()[0]);
  }

  ImageRegionConstIterator( const ImageConstIterator<TImage> &it)
  {
    this->ImageConstIterator<TImage>::operator=(it);
    IndexType ind = this->GetIndex();
    m_SpanEndOffset = m_Offset + static_cast<long>(m_Region.GetSize()[0]) 
      - (ind[0] - m_Region.GetIndex()[0]);
    m_SpanBeginOffset = m_SpanEndOffset
      - static_cast<long>(m_Region.GetSize()[0]);
  }

  Self Begin(void) const;

  Self End(void) const;


  void SetIndex(const IndexType &ind)
  { Superclass::SetIndex(ind);
    m_SpanEndOffset = m_Offset + static_cast<long>(m_Region.GetSize()[0]) 
      - (ind[0] - m_Region.GetIndex()[0]);
    m_SpanBeginOffset = m_SpanEndOffset
      - static_cast<long>(m_Region.GetSize()[0]);
  }
  
  Self &
  operator++()
  {
    if (++m_Offset >= m_SpanEndOffset)
      {
      // We have reached the end of the span (row), need to wrap around.

      // First back up one pixel, because we are going to use a different
      // algorithm to compute the next pixel
      --m_Offset;
      
      // Get the index of the last pixel on the span (row)
      typename ImageIterator<TImage>::IndexType
        ind = m_Image->ComputeIndex( static_cast<typename Superclass::OffsetValueType>(m_Offset) );

      const typename ImageIterator<TImage>::IndexType&
        startIndex = m_Region.GetIndex();
      const typename ImageIterator<TImage>::SizeType&
        size = m_Region.GetSize();

      // Increment along a row, then wrap at the end of the region row.
      bool done;
      unsigned int dim;

      // Check to see if we are past the last pixel in the region
      // Note that ++ind[0] moves to the next pixel along the row.
      done = (++ind[0] == startIndex[0] + static_cast<typename Superclass::IndexValueType>(size[0]));
      for (unsigned int i=1; done && i < ImageIteratorDimension; i++)
        {
        done = (ind[i] == startIndex[i] + static_cast<typename Superclass::IndexValueType>(size[i]) - 1);
        }
      
      // if the iterator is outside the region (but not past region end) then
      // we need to wrap around the region
      dim = 0;
      if (!done)
        {
        while ( ( dim+1 < ImageIteratorDimension )
          && (ind[dim] > startIndex[dim] +  static_cast<typename Superclass::IndexValueType>(size[dim]) - 1) )
          {
          ind[dim] = startIndex[dim];
          ind[++dim]++;
          }
        }
      m_Offset = m_Image->ComputeOffset( ind );
      m_SpanEndOffset = m_Offset + static_cast<long>(size[0]);
      m_SpanBeginOffset = m_Offset;
      }
    return *this;
  }

  Self & operator--()
  {
    if (--m_Offset < m_SpanBeginOffset)
      {
      // We have pasted the beginning of the span (row), need to wrap around.

      // First move forward one pixel, because we are going to use a different
      // algorithm to compute the next pixel
      m_Offset++;
      
      // Get the index of the first pixel on the span (row)
      typename ImageIterator<TImage>::IndexType
        ind = m_Image->ComputeIndex( static_cast<typename Superclass::IndexValueType>(m_Offset) );

      const typename ImageIterator<TImage>::IndexType&
        startIndex = m_Region.GetIndex();
      const typename ImageIterator<TImage>::SizeType&
        size = m_Region.GetSize();

      // Deccrement along a row, then wrap at the beginning of the region row.
      bool done;
      unsigned int dim;

      // Check to see if we are past the first pixel in the region
      // Note that --ind[0] moves to the previous pixel along the row.
      done = (--ind[0] == startIndex[0] - 1);
      for (unsigned int i=1; done && i < ImageIteratorDimension; i++)
        {
        done = (ind[i] == startIndex[i]);
        }
      
      // if the iterator is outside the region (but not past region begin) then
      // we need to wrap around the region
      dim = 0;
      if (!done)
        {
        while ( (dim < ImageIteratorDimension - 1)
                && (ind[dim] < startIndex[dim]) )
          {
          ind[dim] = startIndex[dim] + static_cast<typename Superclass::IndexValueType>(size[dim]) - 1;
          ind[++dim]--;
          }
        }
      m_Offset = m_Image->ComputeOffset( ind );
      m_SpanEndOffset = m_Offset + 1;
      m_SpanBeginOffset = m_SpanEndOffset - static_cast<long>(size[0]);
      }
    return *this;
  }

protected:
  unsigned long m_SpanBeginOffset;  // one pixel before the beginning of the span (row)
  unsigned long m_SpanEndOffset;  // one pixel past the end of the span (row)
       
};

} // end namespace itk

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

#endif 

---