itkLineIterator.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 __itkLineIterator_h
#define __itkLineIterator_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::OffsetType            OffsetType;
  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(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, TypeX, TypeY)     \
  namespace itk                                                \
  {                                                            \
  _( 1 ( class EXPORT LineIterator< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                          \
  {                                                            \
  typedef LineIterator< ITK_TEMPLATE_1 TypeX >                 \
  LineIterator##TypeY;                                       \
  }                                                            \
  }

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

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

#endif