itkImageAdaptor.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 itkImageAdaptor_h
#define itkImageAdaptor_h

#include "itkImage.h"

namespace itk
{

template <typename TPixelType, unsigned int VImageDimension > class VectorImage;

template< typename TImage, typename TAccessor >
class ITK_TEMPLATE_EXPORT ImageAdaptor:public ImageBase< 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 PixelType IOPixelType;

  typedef   TAccessor AccessorType;

  typedef typename InternalImageType::AccessorFunctorType::template Rebind< Self >::Type 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;

  typedef typename Superclass::DirectionType DirectionType;


  template <typename UPixelType, unsigned int UImageDimension =  TImage::ImageDimension>
  struct Rebind
    {
      typedef Image<UPixelType, UImageDimension>  Type;
    };


  virtual void SetLargestPossibleRegion(const RegionType & region) ITK_OVERRIDE;

  virtual void SetBufferedRegion(const RegionType & region) ITK_OVERRIDE;

  virtual void SetRequestedRegion(const RegionType & region) ITK_OVERRIDE;

  virtual void SetRequestedRegion(const DataObject *data) ITK_OVERRIDE;

  virtual const RegionType & GetRequestedRegion() const ITK_OVERRIDE;

  virtual const RegionType & GetLargestPossibleRegion() const ITK_OVERRIDE;

  virtual const RegionType & GetBufferedRegion() const ITK_OVERRIDE;

  virtual void Allocate(bool initialize = false) ITK_OVERRIDE;

  virtual void Initialize() ITK_OVERRIDE;

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

  const PixelContainer * GetPixelContainer() const
  { return m_Image->GetPixelContainer(); }

  void SetPixelContainer(PixelContainer *container);

  virtual void Graft(const Self *imgData);

  typedef InternalPixelType *InternalPixelPointerType;

  InternalPixelType * GetBufferPointer();

  const InternalPixelType * GetBufferPointer() const;

  virtual void SetSpacing(const SpacingType & values) ITK_OVERRIDE;

  virtual void SetSpacing(const double *values /*[ImageDimension]*/) ITK_OVERRIDE;

  virtual void SetSpacing(const float *values /*[ImageDimension]*/) ITK_OVERRIDE;

  virtual const SpacingType & GetSpacing() const ITK_OVERRIDE;

  virtual const PointType & GetOrigin() const ITK_OVERRIDE;

  virtual void SetOrigin(const PointType values) ITK_OVERRIDE;

  virtual void SetOrigin(const double *values /*[ImageDimension]*/) ITK_OVERRIDE;

  virtual void SetOrigin(const float *values /*[ImageDimension]*/) ITK_OVERRIDE;

  virtual void SetDirection(const DirectionType & direction) ITK_OVERRIDE;

  virtual const DirectionType & GetDirection() const ITK_OVERRIDE;

  virtual void SetImage(TImage *);

  virtual void Modified() const ITK_OVERRIDE;

  virtual ModifiedTimeType GetMTime() const ITK_OVERRIDE;

  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() ITK_OVERRIDE;

  virtual void CopyInformation(const DataObject *data) ITK_OVERRIDE;

  virtual void UpdateOutputInformation() ITK_OVERRIDE;

  virtual void SetRequestedRegionToLargestPossibleRegion() ITK_OVERRIDE;

  virtual void PropagateRequestedRegion() ITK_OVERRIDE;

  virtual void UpdateOutputData() ITK_OVERRIDE;

  virtual bool VerifyRequestedRegion() ITK_OVERRIDE;

  template< typename TCoordRep >
  bool TransformPhysicalPointToContinuousIndex(
    const Point< TCoordRep,
                 itkGetStaticConstMacro(ImageDimension) > & point,
    ContinuousIndex< TCoordRep,
                     itkGetStaticConstMacro(ImageDimension) > & index) const
  {
    return m_Image->TransformPhysicalPointToContinuousIndex(point, index);
  }

  template< typename TCoordRep >
  bool TransformPhysicalPointToIndex(
    const Point< TCoordRep,
                 itkGetStaticConstMacro(ImageDimension) > & point,
    IndexType & index) const
  {
    return m_Image->TransformPhysicalPointToIndex(point, index);
  }

  template< typename TCoordRep >
  void TransformContinuousIndexToPhysicalPoint(
    const ContinuousIndex< TCoordRep,
                           itkGetStaticConstMacro(ImageDimension) > & index,
    Point< TCoordRep,
           itkGetStaticConstMacro(ImageDimension) > & point) const
  {
    m_Image->TransformContinuousIndexToPhysicalPoint(index, point);
  }

  template< typename TCoordRep >
  void TransformIndexToPhysicalPoint(
    const IndexType & index,
    Point< TCoordRep,
           itkGetStaticConstMacro(ImageDimension) > & point) const
  {
    m_Image->TransformIndexToPhysicalPoint(index, point);
  }

  template< typename TCoordRep >
  void TransformLocalVectorToPhysicalVector(
    const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > & inputGradient,
    FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > & outputGradient) const
  {
    m_Image->TransformLocalVectorToPhysicalVector(inputGradient, outputGradient);
  }

  template< typename TCoordRep >
  void TransformPhysicalVectorToLocalVector(
    const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > & inputGradient,
    FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > & outputGradient) const
  {
    m_Image->TransformPhysicalVectorToLocalVector(inputGradient, outputGradient);
  }

protected:

  ImageAdaptor();
  virtual ~ImageAdaptor() ITK_OVERRIDE;
  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
  virtual void Graft(const DataObject *data) ITK_OVERRIDE;
  using Superclass::Graft;

private:

  ITK_DISALLOW_COPY_AND_ASSIGN(ImageAdaptor);

  // a specialized method to update PixelAccessors for VectorImages,
  // to have the correct vector length of the image.
  template< typename TPixelType >
    void UpdateAccessor( typename ::itk::VectorImage< TPixelType, ImageDimension > * itkNotUsed( dummy ) )
  {
    this->m_PixelAccessor.SetVectorLength( this->m_Image->GetNumberOfComponentsPerPixel() );
  }

  // The other image types don't expect an accessor which needs any updates
  template< typename T > void UpdateAccessor( T  *itkNotUsed( dummy ) ) { }

  // 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.hxx"
#endif

#endif