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:
  typedef RLEImage                          Self;
  typedef itk::ImageBase< VImageDimension > Superclass;
  typedef itk::SmartPointer< Self >         Pointer;
  typedef itk::SmartPointer< const Self >   ConstPointer;
  typedef itk::WeakPointer< const Self >    ConstWeakPointer;

  itkNewMacro( Self );

  itkTypeMacro( RLEImage, ImageBase );

  typedef TPixel PixelType;

  typedef CounterType RLCounterType;

  typedef TPixel ValueType;

  typedef std::pair< CounterType, PixelType > RLSegment;

  typedef std::vector< RLSegment > RLLine;

  typedef RLLine InternalPixelType;

  // typedef PixelType IOPixelType;

  itkStaticConstMacro( ImageDimension, unsigned int, VImageDimension );

  typedef typename Superclass::IndexType      IndexType;
  typedef typename Superclass::IndexValueType IndexValueType;

  typedef typename Superclass::OffsetType OffsetType;

  typedef typename Superclass::SizeType      SizeType;
  typedef typename Superclass::SizeValueType SizeValueType;

  typedef typename Superclass::DirectionType DirectionType;

  typedef typename Superclass::RegionType RegionType;

  typedef typename Superclass::SpacingType      SpacingType;
  typedef typename Superclass::SpacingValueType SpacingValueType;

  typedef typename Superclass::PointType PointType;

  typedef typename Superclass::OffsetValueType OffsetValueType;

  virtual void
  Allocate( bool initialize = false );

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

  void
  FillBuffer( const TPixel& value );

  virtual void
  SetLargestPossibleRegion( const RegionType& region )
  {
    Superclass::SetLargestPossibleRegion( region );
    m_Buffer->SetLargestPossibleRegion( truncateRegion( region ) );
  }

  virtual void
  SetBufferedRegion( const RegionType& region )
  {
    Superclass::SetBufferedRegion( region );
    m_Buffer->SetBufferedRegion( truncateRegion( region ) );
  }

  using ImageBase< VImageDimension >::SetRequestedRegion;

  virtual void
  SetRequestedRegion( const RegionType& region )
  {
    Superclass::SetRequestedRegion( region );
    m_Buffer->SetRequestedRegion( truncateRegion( region ) );
  }

  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 );
  }

  virtual unsigned int
  GetNumberOfComponentsPerPixel() const
  {
    // 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 );
  }

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

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

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

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

  static inline typename BufferType::SizeType
  truncateSize( const SizeType& size );

  static typename BufferType::RegionType
  truncateRegion( const RegionType& region );

  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_OnTheFlyCleanup = true;
    m_Buffer = BufferType::New();
  }

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

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

  void
  CleanUpLine( RLLine& line ) const;

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

  RLEImage( const Self & ); // purposely not implemented
  void
  operator=( const Self & ); // purposely not implemented

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

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

#endif // itkRLEImage_h