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:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageAdaptor);

  static constexpr unsigned int ImageDimension = TImage::ImageDimension;

  using Self = ImageAdaptor;
  using Superclass = ImageBase< Self::ImageDimension >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using ConstWeakPointer = WeakPointer< const Self >;

  itkTypeMacro(ImageAdaptor, ImageBase);

  using InternalImageType = TImage;

  itkNewMacro(Self);

  using PixelType = typename TAccessor::ExternalType;

  using InternalPixelType = typename TAccessor::InternalType;

  using IOPixelType = PixelType;

  using AccessorType = TAccessor;

  using AccessorFunctorType = typename InternalImageType::AccessorFunctorType::template Rebind< Self >::Type;

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

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

  using OffsetType = typename Superclass::OffsetType;
  using OffsetValueType = typename OffsetType::OffsetValueType;

  using RegionType = typename Superclass::RegionType;

  using SpacingType = typename Superclass::SpacingType;

  using PointType = typename Superclass::PointType;

  using DirectionType = typename Superclass::DirectionType;


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

  template <typename UPixelType, unsigned int NUImageDimension = TImage::ImageDimension>
    using RebindImageType = itk::Image<UPixelType, NUImageDimension>;


  void SetLargestPossibleRegion(const RegionType & region) override;

  void SetBufferedRegion(const RegionType & region) override;

  void SetRequestedRegion(const RegionType & region) override;

  void SetRequestedRegion(const DataObject *data) override;

  const RegionType & GetRequestedRegion() const override;

  const RegionType & GetLargestPossibleRegion() const override;

  const RegionType & GetBufferedRegion() const override;

  void Allocate(bool initialize = false) override;

  void Initialize() 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;

  using PixelContainer = typename TImage::PixelContainer;
  using PixelContainerPointer = typename TImage::PixelContainerPointer;
  using PixelContainerConstPointer = typename TImage::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);

  using InternalPixelPointerType = InternalPixelType *;

  InternalPixelType * GetBufferPointer();

  const InternalPixelType * GetBufferPointer() const;

  void SetSpacing(const SpacingType & values) override;

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

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

  const SpacingType & GetSpacing() const override;

  const PointType & GetOrigin() const override;

  void SetOrigin(const PointType values) override;

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

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

  void SetDirection(const DirectionType & direction) override;

  const DirectionType & GetDirection() const override;

  virtual void SetImage(TImage *);

  void Modified() const override;

  ModifiedTimeType GetMTime() const override;

  AccessorType & GetPixelAccessor()
  { return m_PixelAccessor; }

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

  void SetPixelAccessor(const AccessorType & accessor)
  { m_PixelAccessor = accessor; }

  void Update() override;

  void CopyInformation(const DataObject *data) override;

  void UpdateOutputInformation() override;

  void SetRequestedRegionToLargestPossibleRegion() override;

  void PropagateRequestedRegion() override;

  void UpdateOutputData() override;

  bool VerifyRequestedRegion() override;

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

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

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

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

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

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

protected:

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

private:

  // 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