itkImageSliceConstIteratorWithIndex.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 itkImageSliceConstIteratorWithIndex_h
#define itkImageSliceConstIteratorWithIndex_h

#include "itkImageConstIteratorWithIndex.h"

namespace itk
{
template< typename TImage >
class ITK_TEMPLATE_EXPORT ImageSliceConstIteratorWithIndex:public ImageConstIteratorWithIndex< TImage >
{
public:
  typedef ImageSliceConstIteratorWithIndex      Self;
  typedef ImageConstIteratorWithIndex< 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;

  ImageSliceConstIteratorWithIndex():ImageConstIteratorWithIndex< TImage >() {}

  ImageSliceConstIteratorWithIndex(const ImageType *ptr,
                                   const RegionType & region):
    ImageConstIteratorWithIndex< TImage >(ptr, region),
    m_PixelJump(0),
    m_LineJump(0),
    m_Direction_A(0),
    m_Direction_B(1)
  {
  }

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

  void NextLine();

  void GoToBeginOfSlice();

  void NextSlice();

  void PreviousLine();

  void PreviousSlice();

  bool IsAtEndOfLine();

  bool IsAtEndOfSlice();

  bool IsAtReverseEndOfLine();

  bool IsAtReverseEndOfSlice();

  void SetFirstDirection(unsigned int direction);

  void SetSecondDirection(unsigned int direction);

  inline Self & operator++();

  inline Self & operator--();

private:
  SizeValueType m_PixelJump;
  SizeValueType m_LineJump;
  unsigned int  m_Direction_A;
  unsigned int  m_Direction_B;
};
} // end namespace itk

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

#endif