itkRLEImageIterator.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 itkRLEImageIterator_h
#define itkRLEImageIterator_h

#include "itkImageIteratorWithIndex.h"
#include "itkRLEImageConstIterator.h"

namespace itk
{
template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > > :
  public ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
{
public:
  using Self = ImageIterator;

  static constexpr unsigned int ImageIteratorDimension = VImageDimension;

  using Superclass = ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >;

  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;

  ImageIterator() {}

  ~ImageIterator() override {}

  ImageIterator( const Self& it )
    : ImageConstIterator< ImageType >( it )
  {}

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

  Self &
  operator=( const Self& it )
  {
    ImageConstIterator< ImageType >::operator=( it );
    return *this;
  }

  void
  Set( const PixelType& value ) const
  {
    const_cast< ImageType * >( this->m_Image.GetPointer() )->SetPixel(
      *const_cast< typename ImageType::RLLine * >( this->m_RunLengthLine ),
      this->m_SegmentRemainder, this->m_RealIndex, value );
  }

  // PixelType & Value(void)
  // {
  //    return m_Buffer[m_Index[2]][m_Index[1]][m_RealIndex].second;
  // }

  ImageType *
  GetImage() const
  {
    // const_cast is needed here because m_Image is declared as a const pointer
    // in the base class which is the ConstIterator.
    return const_cast< ImageType * >( this->m_Image.GetPointer() );
  }

protected:
  ImageIterator( const ImageConstIterator< ImageType >& it )
    : ImageConstIterator< ImageType >( it )
  {}
  Self &
  operator=( const ImageConstIterator< ImageType >& it )
  {
    ImageConstIterator< ImageType >::operator=( it );
    return *this;
  }
};

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

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

  ImageIteratorWithIndex()
    : ImageConstIteratorWithIndex< ImageType >()
  {}

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

  ImageIteratorWithIndex( const ImageType* ptr, const RegionType& region )
    : ImageConstIteratorWithIndex< ImageType >( ptr, region )
  {}

  void
  Set( const TPixel& value ) const
  {
    const_cast< ImageType * >( this->m_Image.GetPointer() )->SetPixel(
      *const_cast< typename ImageType::RLLine * >( this->m_RunLengthLine ),
      this->m_SegmentRemainder, this->m_RealIndex, value );
  }

  ImageType *
  GetImage() const
  {
    // const_cast is needed here because m_Image is declared as a const pointer
    // in the base class which is the ConstIterator.
    return const_cast< ImageType * >( this->m_Image.GetPointer() );
  }
}; // no additional implementation required
} // end namespace itk

#endif // itkRLEImageIterator_h