itkImageRegionConstIterator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageRegionConstIterator.h,v $
  Language:  C++
  Date:      $Date: 2008-10-18 21:13:25 $
  Version:   $Revision: 1.23 $

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

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

#if defined(_MSC_VER) && !defined(ITK_LEAN_AND_MEAN)
#define ITK_LEAN_AND_MEAN
#endif

namespace itk
{

template<typename TImage>
class ITK_EXPORT 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 = this->m_BeginOffset;
    m_SpanEndOffset   = this->m_BeginOffset + static_cast<long>(this->m_Region.GetSize()[0]);
    }

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

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

  void GoToBegin()
    {
    Superclass::GoToBegin();

    // reset the span offsets
    m_SpanBeginOffset = this->m_BeginOffset;
    m_SpanEndOffset   = this->m_BeginOffset + static_cast<long>(this->m_Region.GetSize()[0]);
    }
  
  void GoToEnd()
    {
    Superclass::GoToEnd();
    
    // reset the span offsets
    m_SpanEndOffset = this->m_EndOffset;
    m_SpanBeginOffset = m_SpanEndOffset - static_cast<long>(this->m_Region.GetSize()[0]);
    }

  Self Begin(void) const;

  Self End(void) const;


  void SetIndex(const IndexType &ind)
    {
    Superclass::SetIndex(ind);
    m_SpanEndOffset = this->m_Offset + static_cast<long>(this->m_Region.GetSize()[0]) 
      - (ind[0] - this->m_Region.GetIndex()[0]);
    m_SpanBeginOffset = m_SpanEndOffset - static_cast<long>(this->m_Region.GetSize()[0]);
    }
  
  Self &
  operator++()
    {
    if (++this->m_Offset >= m_SpanEndOffset)
      {
      this->Increment();
      }
    return *this;
    }

  Self & operator--()
    {
    if (--this->m_Offset < m_SpanBeginOffset)
      {
      this->Decrement();
      }
    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)
       
private:
  void Increment(); // advance in a direction other than the fastest moving
  void Decrement(); // go back in a direction other than the fastest moving
 
};

} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageRegionConstIterator(_, EXPORT, x, y) namespace itk { \
  _(1(class EXPORT ImageRegionConstIterator< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef ImageRegionConstIterator< ITK_TEMPLATE_1 x > ImageRegionConstIterator##y; } \
  }


#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkImageRegionConstIterator+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkImageRegionConstIterator.txx"
#endif

#if defined(_MSC_VER)
#undef ITK_LEAN_AND_MEAN
#endif

#endif