itkImageAdaptor.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageAdaptor.h,v $
  Language:  C++
  Date:      $Date: 2005/12/03 22:15:26 $
  Version:   $Revision: 1.58.2.1 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkImageAdaptor_h
#define __itkImageAdaptor_h

#include "itkImage.h"
#include "itkDefaultPixelAccessorFunctor.h"

namespace itk
{

template <class TImage, class TAccessor >
class ITK_EXPORT ImageAdaptor : public ImageBase< ::itk::GetImageDimension<TImage>::ImageDimension>
{
public:
  itkStaticConstMacro(ImageDimension, unsigned int, TImage::ImageDimension);

  typedef ImageAdaptor  Self;
  typedef ImageBase<itkGetStaticConstMacro(ImageDimension)> Superclass;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  typedef WeakPointer<const Self>  ConstWeakPointer;
  
  itkTypeMacro(ImageAdaptor, ImageBase);

  typedef TImage InternalImageType;
  
  itkNewMacro(Self);  

  typedef typename TAccessor::ExternalType PixelType;

  typedef typename TAccessor::InternalType InternalPixelType;

  typedef   TAccessor   AccessorType;

  typedef DefaultPixelAccessorFunctor< Self > AccessorFunctorType;

  typedef typename Superclass::IndexType  IndexType;
  typedef typename IndexType::IndexValueType    IndexValueType;
  
  typedef typename Superclass::SizeType  SizeType;
  typedef typename SizeType::SizeValueType      SizeValueType;
    
  typedef typename Superclass::OffsetType OffsetType;
  typedef typename OffsetType::OffsetValueType  OffsetValueType;
    
  typedef typename Superclass::RegionType RegionType;

  typedef typename Superclass::SpacingType SpacingType;

  typedef typename Superclass::PointType PointType;

  virtual void SetLargestPossibleRegion(const RegionType &region);

  virtual void SetBufferedRegion(const RegionType &region);

  virtual void SetRequestedRegion(const RegionType &region);

  virtual void SetRequestedRegion(DataObject *data);

  virtual const RegionType & GetRequestedRegion() const;

  virtual const RegionType& GetLargestPossibleRegion() const;

  virtual const RegionType& GetBufferedRegion() const;

  inline void Allocate();


  virtual void Initialize();

  void SetPixel(const IndexType &index, const PixelType & value)
    { m_PixelAccessor.Set( m_Image->GetPixel(index), value ); }
  
  PixelType GetPixel(const IndexType &index) const
    { return m_PixelAccessor.Get( m_Image->GetPixel(index) ); }

  PixelType operator[](const IndexType &index) const
    { return m_PixelAccessor.Get( m_Image->GetPixel(index) ); }

  const OffsetValueType *GetOffsetTable() const;

  IndexType ComputeIndex(OffsetValueType offset) const;

  typedef typename TImage::PixelContainer        PixelContainer;
  typedef typename TImage::PixelContainerPointer PixelContainerPointer;
  typedef typename TImage::PixelContainerConstPointer PixelContainerConstPointer;
  
  PixelContainerPointer GetPixelContainer()
    { return m_Image->GetPixelContainer(); };

  void SetPixelContainer( PixelContainer *container );

  virtual void Graft(const DataObject *data);
  
  typedef InternalPixelType * InternalPixelPointerType;

  InternalPixelType *GetBufferPointer();
  const InternalPixelType *GetBufferPointer() const;
  void GetBufferPointer2( InternalPixelPointerType  & );
  
  virtual void SetSpacing( const SpacingType values );
  virtual void SetSpacing( const double* values /*[ImageDimension]*/ );
  virtual void SetSpacing( const float* values /*[ImageDimension]*/ );
  
  virtual const SpacingType& GetSpacing() const;
 
  virtual const PointType& GetOrigin() const;

  virtual void SetOrigin( const PointType values);
  virtual void SetOrigin( const double* values /*[ImageDimension]*/ );
  virtual void SetOrigin( const float* values /*[ImageDimension]*/ );
  
  virtual void SetImage( TImage * );

  virtual void Modified() const;

  virtual unsigned long GetMTime() const;

  AccessorType & GetPixelAccessor( void ) 
    { return m_PixelAccessor; }
    
  const AccessorType & GetPixelAccessor( void ) const
    { return m_PixelAccessor; }

  void SetPixelAccessor( const AccessorType & accessor ) 
    { m_PixelAccessor = accessor; }
 
  virtual void Update();
  virtual void CopyInformation(const DataObject *data);

  virtual void UpdateOutputInformation();
  virtual void SetRequestedRegionToLargestPossibleRegion();
  virtual void PropagateRequestedRegion() throw (InvalidRequestedRegionError);
  virtual void UpdateOutputData();
  virtual bool VerifyRequestedRegion();
 
protected:
  ImageAdaptor();
  virtual ~ImageAdaptor();
  void PrintSelf(std::ostream& os, Indent indent) const;
  
private:
  ImageAdaptor(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  // Adapted image, most of the calls to ImageAdaptor
  // will be delegated to this image
  typename TImage::Pointer   m_Image;

  // Data accessor object, 
  // it converts the presentation of a pixel
  AccessorType               m_PixelAccessor;
  

};
  
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageAdaptor.txx"
#endif
  
  

#endif

---