itkRLEImageScanlineConstIterator.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 itkRLEImageScanlineConstIterator_h
#define itkRLEImageScanlineConstIterator_h

#include "itkImageScanlineIterator.h"
#include "itkRLEImageRegionConstIterator.h"

namespace itk
{
template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > > :
  public ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
{
public:
  using Self = ImageScanlineConstIterator;
  using Superclass = ImageRegionConstIterator< 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( ImageScanlineConstIterator, ImageRegionConstIterator );

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

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

  ImageScanlineConstIterator( const ImageIterator< ImageType >& it )
    : ImageRegionConstIterator< ImageType >( it )
  {}

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

  void
  GoToBeginOfLine( void )
  {
    this->m_Index0 = this->m_BeginIndex0;
    this->m_RealIndex = 0;
    this->m_SegmentRemainder = ( *this->m_RunLengthLine )[this->m_RealIndex].first;
  }

  void
  GoToEndOfLine( void )
  {
    this->m_Index0 = this->m_EndIndex0;
    this->m_RealIndex = this->m_RunLengthLine->size() - 1;
    this->m_SegmentRemainder = 0;
  }

  inline bool
  IsAtEndOfLine( void )
  {
    return this->m_Index0 == this->m_EndIndex0;
  }

  inline void
  NextLine( void )
  {
    ++( this->m_BI );
    if ( !this->m_BI.IsAtEnd() )
      {
      this->SetIndexInternal( this->m_BeginIndex0 );
      }
    else
      {
      this->m_Index0 = this->m_BeginIndex0; // make this iterator at end too
      }
  }

  Self &
  operator++()
  {
    itkAssertInDebugAndIgnoreInReleaseMacro( !this->IsAtEndOfLine() );
    this->m_Index0++;
    this->m_SegmentRemainder--;
    if ( this->m_SegmentRemainder > 0 )
      {
      return *this;
      }

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

  Self &
  operator--()
  {
    this->m_Index0--;
    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;
  }
};
} // end namespace itk

#endif // itkRLEImageScanlineConstIterator_h