itkRLEImageRegionConstIterator.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 itkRLEImageRegionConstIterator_h
#define itkRLEImageRegionConstIterator_h

#include "itkImageRegionConstIterator.h"
#include "itkImageRegionConstIteratorWithIndex.h"
#include "itkImageRegionConstIteratorWithOnlyIndex.h"
#include "itkRLEImageConstIterator.h"

class MultiLabelMeshPipeline;

namespace itk
{
template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > > :
  public ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
{
  friend class ::MultiLabelMeshPipeline;

public:
  using Self = ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >;
  using Superclass = ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >;

  static constexpr unsigned int ImageIteratorDimension = VImageDimension;

  using IndexType = typename Superclass::IndexType;
  using SizeType = typename Superclass::SizeType;
  using OffsetType = typename Superclass::OffsetType;
  using RegionType = typename Superclass::RegionType;
  using ImageType = typename Superclass::ImageType;
  using InternalPixelType = typename Superclass::InternalPixelType;
  using PixelType = typename Superclass::PixelType;

  itkTypeMacro( ImageRegionConstIterator, ImageConstIterator );

  ImageRegionConstIterator()
    : ImageConstIterator< ImageType >()
  {}

  ImageRegionConstIterator( const ImageType* ptr, const RegionType& region )
    : ImageConstIterator< ImageType >( ptr, region )
  {}

  ImageRegionConstIterator( const ImageIterator< ImageType >& it )
  {
    ImageConstIterator< ImageType >::operator=( it );
  }

  ImageRegionConstIterator( const ImageConstIterator< ImageType >& it )
  {
    ImageConstIterator< ImageType >::operator=( it );
  }

  Self &
  operator++()
  {
    this->m_Index0++;

    if ( this->m_Index0 >= this->m_EndIndex0 )
      {
      ++( this->m_BI );
      if ( !this->m_BI.IsAtEnd() )
        {
        this->SetIndexInternal( this->m_BeginIndex0 );
        }
      else
        {
        this->m_Index0 = this->m_BeginIndex0;
        }
      return *this;
      }

    this->m_SegmentRemainder--;
    if ( this->m_SegmentRemainder > 0 )
      {
      return *this;
      }

    this->m_RealIndex++;
    this->m_SegmentRemainder = ( *this->m_RunLengthLine )[this->m_RealIndex].first;
    return *this;
  } // ++

  Self &
  operator--()
  {
    this->m_Index0--;

    if ( this->m_Index0 < this->m_BeginIndex0 )
      {
      --( this->m_BI );
      this->SetIndexInternal( this->m_EndIndex0 - 1 );
      return *this;
      }

    this->m_SegmentRemainder++;
    if ( this->m_SegmentRemainder <= ( *this->m_RunLengthLine )[this->m_RealIndex].first )
      {
      return *this;
      }

    this->m_RealIndex--;
    this->m_SegmentRemainder = 1;
    return *this;
  } // --
};

template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class ImageRegionConstIteratorWithIndex< RLEImage< TPixel, VImageDimension, CounterType > > :
  public ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
{
public:
  using ImageType = RLEImage< TPixel, VImageDimension, CounterType >;

  using RegionType = typename itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::RegionType;

  ImageRegionConstIteratorWithIndex()
    : ImageRegionConstIterator< ImageType >()
  {}

  ImageRegionConstIteratorWithIndex( const ImageType* ptr, const RegionType& region )
    : ImageRegionConstIterator< ImageType >( ptr, region )
  {}

  void
  GoToReverseBegin()
  {
    this->m_BI.GoToEnd(); // after last pixel
    --( this->m_BI ); // go to last valid pixel
    this->m_Index0 = this->m_EndIndex0 - 1;
    this->SetIndexInternal( this->m_Index0 ); // valid index required
  }

  bool
  IsAtReverseEnd()
  {
    return ( this->m_Index0 == this->m_BeginIndex0 ) && this->m_BI.IsAtBegin();
  }

  ImageRegionConstIteratorWithIndex( const ImageIterator< ImageType >& it )
  {
    ImageRegionConstIterator< ImageType >::operator=( it );
  }
}; // no additional implementation required

template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class ImageRegionConstIteratorWithOnlyIndex< RLEImage< TPixel, VImageDimension, CounterType > > :
  public ImageRegionConstIteratorWithIndex< RLEImage< TPixel, VImageDimension, CounterType > >
{
// just inherit constructors

public:
  using ImageType = RLEImage< TPixel, VImageDimension, CounterType >;

  using RegionType = typename itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::RegionType;

  ImageRegionConstIteratorWithOnlyIndex()
    : ImageRegionConstIterator< ImageType >()
  {}

  ImageRegionConstIteratorWithOnlyIndex( const ImageType* ptr, const RegionType& region )
    : ImageRegionConstIteratorWithIndex< ImageType >( ptr, region )
  {}

  ImageRegionConstIteratorWithOnlyIndex( const ImageIterator< ImageType >& it )
  {
    ImageRegionConstIterator< ImageType >::operator=( it );
  }
}; // no additional implementation required
} // end namespace itk

#endif // itkRLEImageRegionConstIterator_h