itkImageIterator.h

Go to the documentation of this file.

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

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

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

#include "itkImageConstIterator.h"

namespace itk
{

template<typename TImage>
class ITK_EXPORT ImageIterator : public ImageConstIterator<TImage>
{
public:

  typedef ImageIterator Self;

  itkStaticConstMacro(ImageIteratorDimension, unsigned int,
                      TImage::ImageDimension);

  typedef ImageConstIterator<TImage> Superclass;

  typedef typename Superclass::IndexType              IndexType;
  typedef typename Superclass::IndexValueType         IndexValueType;
  typedef typename Superclass::SizeType               SizeType;
  typedef typename Superclass::SizeValueType          SizeValueType;
  typedef typename Superclass::OffsetType             OffsetType;
  typedef typename Superclass::OffsetValueType        OffsetValueType;
  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;


  ImageIterator();

  ~ImageIterator() {};


  ImageIterator(const Self& it);

  ImageIterator(TImage *ptr, const RegionType& region);

  Self &operator=(const Self& it);

  void Set( const PixelType & value ) const  
    { 
    // const_cast is needed here because m_Buffer is declared as a const
    // pointer in the superclass which is the ConstIterator.
    this->m_PixelAccessorFunctor.Set(
      *(const_cast<InternalPixelType *>(this->m_Buffer)+this->m_Offset), value); 
    }

  PixelType & Value(void) 
    { 
    // const_cast is needed here because m_Buffer is declared as a const
    // pointer in the superclass which is the ConstIterator.
    return *(const_cast<InternalPixelType *>(this->m_Buffer)+this->m_Offset);
    }

  Self Begin(void) const;

  Self End(void) const;

  ImageType * GetImage() const
    {
    // const_cast is needed here because m_Image is declared as a const pointer
    // in the base class which is the ConstIterator.
    return const_cast<ImageType *>( this->m_Image.GetPointer() );
    }


protected:

  ImageIterator(const ImageConstIterator<TImage> & it);
  Self &operator=(const ImageConstIterator<TImage> & it);
};

} // end namespace itk

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

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

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

#endif