itkImageAdaptor.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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_MOVE(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>;

  itkOverrideGetNameOfClassMacro(ImageAdaptor);

  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 typename Superclass::IndexType;
  using IndexValueType = typename IndexType::IndexValueType;

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

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

  using typename Superclass::RegionType;

  using typename Superclass::SpacingType;

  using typename Superclass::PointType;

  using typename Superclass::DirectionType;
 

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

  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;

  OffsetValueType
  ComputeOffset(const IndexType & index) const
  {
    return m_Image->ComputeOffset(index);
  }

  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);
 
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using InternalPixelPointerType [[deprecated("Please just use `InternalPixelType *` instead!")]] = InternalPixelType *;
#endif

  InternalPixelType *
  GetBufferPointer();
 
  const InternalPixelType *
  GetBufferPointer() const;

  void
  SetSpacing(const SpacingType & spacing) override;
 
  void
  SetSpacing(const double * spacing /*[ImageDimension]*/) override;
 
  void
  SetSpacing(const float * spacing /*[ImageDimension]*/) override;

  const SpacingType &
  GetSpacing() const override;

  const PointType &
  GetOrigin() const override;

  void
  SetOrigin(const PointType origin) override;
 
  void
  SetOrigin(const double * origin /*[ImageDimension]*/) override;
 
  void
  SetOrigin(const float * origin /*[ImageDimension]*/) override;

  void
  SetDirection(const DirectionType & direction) override;

  const DirectionType &
  GetDirection() const override;

  virtual void
  SetImage(TImage *);

  void
  Modified() const override;

  [[nodiscard]] 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 TIndexRep, typename TCoordinate>
  [[nodiscard]] ContinuousIndex<TIndexRep, TImage::ImageDimension>
  TransformPhysicalPointToContinuousIndex(const Point<TCoordinate, TImage::ImageDimension> & point) const
  {
    return m_Image->template TransformPhysicalPointToContinuousIndex<TIndexRep>(point);
  }

  template <typename TCoordinate>
  ITK_NODISCARD("Call the overload which has the point as the only parameter and returns the index")
  bool TransformPhysicalPointToContinuousIndex(const Point<TCoordinate, Self::ImageDimension> &     point,
                                               ContinuousIndex<TCoordinate, Self::ImageDimension> & index) const
  {
    return m_Image->TransformPhysicalPointToContinuousIndex(point, index);
  }

  template <typename TCoordinate>
  [[nodiscard]] IndexType
  TransformPhysicalPointToIndex(const Point<TCoordinate, Self::ImageDimension> & point) const
  {
    return m_Image->TransformPhysicalPointToIndex(point);
  }

  template <typename TCoordinate>
  ITK_NODISCARD("Call the overload which has the point as the only parameter and returns the index")
  bool TransformPhysicalPointToIndex(const Point<TCoordinate, Self::ImageDimension> & point, IndexType & index) const
  {
    return m_Image->TransformPhysicalPointToIndex(point, index);
  }

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

  template <typename TCoordinate, typename TIndexRep>
  [[nodiscard]] Point<TCoordinate, TImage::ImageDimension>
  TransformContinuousIndexToPhysicalPoint(const ContinuousIndex<TIndexRep, Self::ImageDimension> & index) const
  {
    return m_Image->template TransformContinuousIndexToPhysicalPoint<TIndexRep>(index);
  }

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

  template <typename TCoordinate>
  [[nodiscard]] Point<TCoordinate, Self::ImageDimension>
  TransformIndexToPhysicalPoint(const IndexType & index) const
  {
    return m_Image->template TransformIndexToPhysicalPoint<TCoordinate>(index);
  }
 
  template <typename TCoordinate>
  void
  TransformLocalVectorToPhysicalVector(const FixedArray<TCoordinate, Self::ImageDimension> & inputGradient,
                                       FixedArray<TCoordinate, Self::ImageDimension> &       outputGradient) const
  {
    m_Image->TransformLocalVectorToPhysicalVector(inputGradient, outputGradient);
  }
 
  template <typename TVector>
  [[nodiscard]] TVector
  TransformLocalVectorToPhysicalVector(const TVector & inputGradient) const
  {
    TVector outputGradient;
    TransformLocalVectorToPhysicalVector(inputGradient, outputGradient);
    return outputGradient;
  }
 
  template <typename TCoordinate>
  void
  TransformPhysicalVectorToLocalVector(const FixedArray<TCoordinate, Self::ImageDimension> & inputGradient,
                                       FixedArray<TCoordinate, Self::ImageDimension> &       outputGradient) const
  {
    m_Image->TransformPhysicalVectorToLocalVector(inputGradient, outputGradient);
  }
 
  template <typename TVector>
  [[nodiscard]] TVector
  TransformPhysicalVectorToLocalVector(const TVector & inputGradient) const
  {
    TVector outputGradient;
    TransformPhysicalVectorToLocalVector(inputGradient, outputGradient);
    return 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(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