itkImageLinearConstIteratorWithIndex.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkImageLinearConstIteratorWithIndex_h
#define itkImageLinearConstIteratorWithIndex_h

#include "itkImageConstIteratorWithIndex.h"

namespace itk
{
template< typename TImage >
class ITK_TEMPLATE_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 >(),
    m_Jump(0),
    m_Direction(0)
  {}

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

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

  inline void NextLine();

  inline void PreviousLine();

  void GoToBeginOfLine();

  void GoToReverseBeginOfLine();

  void GoToEndOfLine();

  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];
  }

  unsigned int GetDirection()
  {
    return 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:
  OffsetValueType m_Jump;
  unsigned int    m_Direction;
};

//----------------------------------------------------------------------
//  Go to next line
//----------------------------------------------------------------------
template< typename 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< typename 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

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageLinearConstIteratorWithIndex.hxx"
#endif

#endif