itkRLEImage.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 itkRLEImage_h
#define itkRLEImage_h

#include <itkImage.h>
#include <itkImageBase.h>
#include <utility> // std::pair
#include <vector>

namespace itk
{
template< typename TPixel, unsigned int VImageDimension = 3, typename CounterType = unsigned short >
class RLEImage:
  public itk::ImageBase< VImageDimension >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(RLEImage);

  using Self = RLEImage;
  using Superclass = itk::ImageBase< VImageDimension >;
  using Pointer = itk::SmartPointer< Self >;
  using ConstPointer = itk::SmartPointer< const Self >;
  using ConstWeakPointer = itk::WeakPointer< const Self >;

  itkNewMacro( Self );

  itkTypeMacro( RLEImage, ImageBase );

  using PixelType = TPixel;

  using RLCounterType = CounterType;

  using ValueType = TPixel;

  using RLSegment = std::pair< CounterType, PixelType >;

  using RLLine = std::vector< RLSegment >;

  using InternalPixelType = RLLine;

  // using IOPixelType = PixelType;

  static constexpr unsigned int ImageDimension = VImageDimension;

  using IndexType = typename Superclass::IndexType;
  using IndexValueType = typename Superclass::IndexValueType;

  using OffsetType = typename Superclass::OffsetType;

  using SizeType = typename Superclass::SizeType;
  using SizeValueType = typename Superclass::SizeValueType;

  using DirectionType = typename Superclass::DirectionType;

  using RegionType = typename Superclass::RegionType;

  using SpacingType = typename Superclass::SpacingType;
  using SpacingValueType = typename Superclass::SpacingValueType;

  using PointType = typename Superclass::PointType;

  using OffsetValueType = typename Superclass::OffsetValueType;

  void
  Allocate( bool initialize = false ) override;

  void
  Initialize() override
  {
    // Call the superclass which should initialize the BufferedRegion ivar.
    Superclass::Initialize();
    m_OnTheFlyCleanup = true;
    m_Buffer = BufferType::New();
  }

  void
  FillBuffer( const TPixel& value );

  void
  SetLargestPossibleRegion( const RegionType& region ) override
  {
    Superclass::SetLargestPossibleRegion( region );
    m_Buffer->SetLargestPossibleRegion( region.Slice( 0 ) );
  }

  void
  SetBufferedRegion( const RegionType& region ) override
  {
    Superclass::SetBufferedRegion( region );
    m_Buffer->SetBufferedRegion( region.Slice( 0 ) );
  }

  using ImageBase< VImageDimension >::SetRequestedRegion;

  void
  SetRequestedRegion( const RegionType& region ) override
  {
    Superclass::SetRequestedRegion( region );
    m_Buffer->SetRequestedRegion( region.Slice( 0 ) );
  }

  void
  SetPixel( const IndexType& index, const TPixel& value );

  int
  SetPixel( RLLine& line, IndexValueType& segmentRemainder, SizeValueType& m_RealIndex, const TPixel& value );

  const TPixel &
  GetPixel( const IndexType& index ) const;

  // TPixel & GetPixel(const IndexType & index);

  // TPixel & operator[](const IndexType & index)
  // {
  //    return this->GetPixel(index);
  // }

  const TPixel &
  operator[]( const IndexType& index ) const
  {
    return this->GetPixel( index );
  }

  unsigned int
  GetNumberOfComponentsPerPixel() const override
  {
    // use the GetLength() method which works with variable length arrays,
    // to make it work with as much pixel types as possible
    PixelType p;

    return itk::NumericTraits< PixelType >::GetLength( p );
  }

  using BufferType = typename itk::Image< RLLine, VImageDimension - 1 >;

  typename BufferType::Pointer
  GetBuffer()
  {
    return m_Buffer;
  }

  typename BufferType::Pointer
  GetBuffer() const
  {
    return m_Buffer;
  }

  static inline typename BufferType::IndexType
  truncateIndex( const IndexType& index );

  void
  CleanUp() const;

  bool
  GetOnTheFlyCleanup() const
  {
    return m_OnTheFlyCleanup;
  }

  void
  SetOnTheFlyCleanup( bool value )
  {
    if ( value == m_OnTheFlyCleanup )
      {
      return;
      }
    m_OnTheFlyCleanup = value;
    if ( m_OnTheFlyCleanup )
      {
      CleanUp(); // put the image into a clean state
      }
  }

protected:
  RLEImage()
    : itk::ImageBase< VImageDimension >(),
    m_OnTheFlyCleanup( true )
  {
    m_Buffer = BufferType::New();
  }

  void
  PrintSelf( std::ostream& os, itk::Indent indent ) const override;

  ~RLEImage() override {}
  void
  ComputeIndexToPhysicalPointMatrices() override
  {
    this->Superclass::ComputeIndexToPhysicalPointMatrices();
  }

  void
  CleanUpLine( RLLine& line ) const;

private:
  bool m_OnTheFlyCleanup; // should same-valued segments be merged on the fly

  mutable typename BufferType::Pointer m_Buffer;
};
} // namespace itk

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

#endif // itkRLEImage_h