itkImageRegionIterator.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 __itkImageRegionIterator_h
#define __itkImageRegionIterator_h

#include "itkImageRegionConstIterator.h"

namespace itk
{
template< typename TImage >
class ITK_EXPORT ImageRegionIterator:public ImageRegionConstIterator< TImage >
{
public:
  typedef ImageRegionIterator                Self;
  typedef ImageRegionConstIterator< TImage > Superclass;

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

  ImageRegionIterator();

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

  ImageRegionIterator(const ImageIterator< TImage > & it);

  void Set(const PixelType & value) const
  {
    this->m_PixelAccessorFunctor.Set(*( const_cast< InternalPixelType * >(
                                          this->m_Buffer + this->m_Offset ) ), value);
  }

  PixelType & Value(void)
  { return *( const_cast< InternalPixelType * >( this->m_Buffer + this->m_Offset ) ); }

  Self Begin(void) const;

  Self End(void) const;

protected:
  ImageRegionIterator(const ImageRegionConstIterator< TImage > & it);
  Self & operator=(const ImageRegionConstIterator< TImage > & it);
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageRegionIterator(_, EXPORT, TypeX, TypeY)                   \
  namespace itk                                                                     \
  {                                                                                 \
  _( 1 ( class EXPORT ImageRegionIterator< ITK_TEMPLATE_1 TypeX > ) )               \
  namespace Templates                                                               \
  {                                                                                 \
  typedef ImageRegionIterator< ITK_TEMPLATE_1 TypeX > ImageRegionIterator##TypeY; \
  }                                                                                 \
  }

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

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

#endif