itkImageLinearConstIteratorWithIndex.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageLinearConstIteratorWithIndex.h,v $
  Language:  C++
  Date:      $Date: 2008-10-18 20:31:36 $
  Version:   $Revision: 1.17 $

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

#include "itkImageConstIteratorWithIndex.h"

namespace itk
{

template<typename TImage>
class ITK_EXPORT ImageLinearConstIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
{
public:
  typedef ImageLinearConstIteratorWithIndex       Self;
  typedef ImageConstIteratorWithIndex<TImage>     Superclass;

  typedef typename TImage::IndexType   IndexType;

  typedef typename TImage::RegionType RegionType;

  typedef TImage ImageType;

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

  ImageLinearConstIteratorWithIndex() : ImageConstIteratorWithIndex<TImage>() {}

  ImageLinearConstIteratorWithIndex(const ImageType *ptr, const RegionType& region);

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

  inline void NextLine(void);

  inline void PreviousLine(void);

  void GoToBeginOfLine(void);

  void GoToReverseBeginOfLine(void);

  void GoToEndOfLine(void);

  inline bool IsAtEndOfLine(void)
    {
    return this->m_PositionIndex[m_Direction] >= this->m_EndIndex[m_Direction];
    }

  inline bool IsAtReverseEndOfLine(void)
    {
    return this->m_PositionIndex[m_Direction] < this->m_BeginIndex[m_Direction];
    }

  inline void SetDirection(unsigned int direction)
    {
    if( direction >= TImage::ImageDimension )
      {
      itkGenericExceptionMacro(<<"In image of dimension " << TImage::ImageDimension <<" Direction " << direction << " sas selected");
      }
    m_Direction = direction;
    m_Jump = this->m_OffsetTable[ m_Direction ];
    }

  inline Self & operator++()
    {
    this->m_PositionIndex[m_Direction]++;
    this->m_Position += m_Jump;
    return *this;
    }

  inline Self & operator--()
    {
    this->m_PositionIndex[m_Direction]--;
    this->m_Position -= m_Jump;
    return *this;
    }

private:
    unsigned long  m_Jump;
    unsigned int   m_Direction;
};

//----------------------------------------------------------------------
//  Go to next line
//----------------------------------------------------------------------
template<class TImage>
inline
void
ImageLinearConstIteratorWithIndex<TImage>
::NextLine(void)
{

  this->m_Position -= this->m_OffsetTable[ m_Direction ] *
    ( this->m_PositionIndex[ m_Direction ] - this->m_BeginIndex[ m_Direction ] );

  this->m_PositionIndex[m_Direction] = this->m_BeginIndex[m_Direction];

  for( unsigned int n=0; n<TImage::ImageDimension; n++ )
    {

    this->m_Remaining = false;

    if( n == m_Direction )
      {
      continue;
      }

    this->m_PositionIndex[ n  ]++;
    if( this->m_PositionIndex[n] <  this->m_EndIndex[n] )
      {
      this->m_Position += this->m_OffsetTable[ n ];
      this->m_Remaining = true;
      break;
      }
    else
      {
      this->m_Position -= this->m_OffsetTable[ n ] * ( this->m_Region.GetSize()[n]-1 );
      this->m_PositionIndex[ n ] = this->m_BeginIndex[ n ];
      }
    }
}


//----------------------------------------------------------------------
//  Pass to the last pixel on the previous line
//----------------------------------------------------------------------
template<class TImage>
inline
void
ImageLinearConstIteratorWithIndex<TImage>
::PreviousLine(void)
{

  this->m_Position += this->m_OffsetTable[ m_Direction ] *
    ( this->m_EndIndex[ m_Direction ] - 1 - this->m_PositionIndex[ m_Direction ] );

  this->m_PositionIndex[m_Direction] = this->m_EndIndex[m_Direction]-1;


  for( unsigned int n=0; n<TImage::ImageDimension; n++ )
    {

    this->m_Remaining = false;

    if( n == m_Direction )
      {
      continue;
      }

    this->m_PositionIndex[ n  ]--;
    if( this->m_PositionIndex[ n ] >=  this->m_BeginIndex[ n ] )
      {
      this->m_Position -= this->m_OffsetTable[ n ];
      this->m_Remaining = true;
      break;
      }
    else
      {
      this->m_Position += this->m_OffsetTable[ n ] * ( this->m_Region.GetSize()[n]-1 );
      this->m_PositionIndex[ n ] = this->m_EndIndex[ n ] - 1;
      }
    }
}
} // end namespace itk

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

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

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

#endif