itkLineIterator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLineIterator.h,v $
  Language:  C++
  Date:      $Date: 2007-01-30 20:56:09 $
  Version:   $Revision: 1.4 $

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

#include "itkIndex.h"
#include "itkImage.h"
#include "itkLineConstIterator.h"

namespace itk
{

template<class TImage>
class ITK_EXPORT LineIterator : public LineConstIterator<TImage>
{
public:

  typedef LineIterator Self;

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

  typedef LineConstIterator<TImage> Superclass;

  typedef typename Superclass::IndexType              IndexType;
  typedef typename Superclass::IndexValueType         IndexValueType;
  typedef typename Superclass::OffsetType             OffsetType;
  typedef typename Superclass::OffsetValueType        OffsetValueType;
  typedef typename Superclass::SizeType               SizeType;
  typedef typename Superclass::SizeValueType          SizeValueType;
  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(LineIterator, LineConstIterator);

  void Set( const PixelType & value)
    {
    // Normally, this would just be the following:
    //   m_Image->SetPixel(m_CurrentImageIndex,value);
    // However, we don't want a warning about m_Image being a ConstPointer
    // in the Superclass.
    const_cast<ImageType *>(this->m_Image.GetPointer())->
      SetPixel(this->m_CurrentImageIndex,value);
    }

  const PixelType & Value(void) 
    {
    return (this->m_Image->GetPixel(this->m_CurrentImageIndex));
    }

  Self &operator=(const Self& it);

  LineIterator(ImageType *imagePtr, const IndexType &firstIndex,
               const IndexType &lastIndex);

  virtual ~LineIterator() {};
};

} // end namespace itk

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

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

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

#endif