itkSpecialCoordinatesImage.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 itkSpecialCoordinatesImage_h
#define itkSpecialCoordinatesImage_h
 
#include "itkImageBase.h"
#include "itkImportImageContainer.h"
#include "itkDefaultPixelAccessor.h"
#include "itkDefaultPixelAccessorFunctor.h"
#include "itkContinuousIndex.h"
 
namespace itk
{
template <typename TPixel, unsigned int VImageDimension = 2>
class ITK_TEMPLATE_EXPORT SpecialCoordinatesImage : public ImageBase<VImageDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SpecialCoordinatesImage);

  using Self = SpecialCoordinatesImage;
  using Superclass = ImageBase<VImageDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ConstWeakPointer = WeakPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SpecialCoordinatesImage);

  using PixelType = TPixel;

  using ValueType = TPixel;

  using InternalPixelType = TPixel;
 
  using IOPixelType = PixelType;

  using AccessorType = DefaultPixelAccessor<PixelType>;

  using AccessorFunctorType = DefaultPixelAccessorFunctor<Self>;

  static constexpr unsigned int ImageDimension = VImageDimension;

  using typename Superclass::IndexType;

  using typename Superclass::OffsetType;

  using typename Superclass::SizeType;

  using PixelContainer = ImportImageContainer<SizeValueType, PixelType>;

  using typename Superclass::RegionType;

  using typename Superclass::SpacingType;

  using typename Superclass::PointType;

  using PixelContainerPointer = typename PixelContainer::Pointer;
  using PixelContainerConstPointer = typename PixelContainer::ConstPointer;

  void
  Allocate(bool initialize = false) override;

  void
  Initialize() override;

  void
  FillBuffer(const TPixel & value);

  void
  SetPixel(const IndexType & index, const TPixel & value)
  {
    const OffsetValueType offset = this->FastComputeOffset(index);
    (*m_Buffer)[offset] = value;
  }

  const TPixel &
  GetPixel(const IndexType & index) const
  {
    const OffsetValueType offset = this->FastComputeOffset(index);
    return ((*m_Buffer)[offset]);
  }

  TPixel &
  GetPixel(const IndexType & index)
  {
    const OffsetValueType offset = this->FastComputeOffset(index);
    return ((*m_Buffer)[offset]);
  }

  TPixel &
  operator[](const IndexType & index)
  {
    return this->GetPixel(index);
  }

  const TPixel &
  operator[](const IndexType & index) const
  {
    return this->GetPixel(index);
  }

  TPixel *
  GetBufferPointer()
  {
    return m_Buffer ? m_Buffer->GetBufferPointer() : nullptr;
  }
  const TPixel *
  GetBufferPointer() const
  {
    return m_Buffer ? m_Buffer->GetBufferPointer() : nullptr;
  }


  PixelContainer *
  GetPixelContainer()
  {
    return m_Buffer.GetPointer();
  }
 
  const PixelContainer *
  GetPixelContainer() const
  {
    return m_Buffer.GetPointer();
  }

  void
  SetPixelContainer(PixelContainer * container);

  AccessorType
  GetPixelAccessor()
  {
    return AccessorType();
  }

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

  void
  SetSpacing(const SpacingType &) override
  {}
  void
  SetSpacing(const double[VImageDimension]) override
  {}
  void
  SetSpacing(const float[VImageDimension]) override
  {}
  void
  SetOrigin(const PointType) override
  {}
  void
  SetOrigin(const double[VImageDimension]) override
  {}
  void
  SetOrigin(const float[VImageDimension]) override
  {}

 
  /* It is ILLEGAL in C++ to make a templated member function virtual! */
  /* Therefore, we must just let templates take care of everything.    */
  /*
  template<typename TCoordinate>
  virtual bool TransformPhysicalPointToContinuousIndex(
              const Point<TCoordinate, VImageDimension>& point,
              ContinuousIndex<TCoordinate, VImageDimension>& index   ) const = 0;
 
  template<typename TCoordinate>
  virtual bool TransformPhysicalPointToIndex(
            const Point<TCoordinate, VImageDimension>&,
            IndexType & index                                ) const = 0;
 
  template<typename TCoordinate>
  virtual void TransformContinuousIndexToPhysicalPoint(
            const ContinuousIndex<TCoordinate, VImageDimension>& index,
            Point<TCoordinate, VImageDimension>& point        ) const = 0;
 
  template<typename TCoordinate>
  virtual void TransformIndexToPhysicalPoint(
                      const IndexType & index,
                      Point<TCoordinate, VImageDimension>& point ) const = 0;
  */
 
protected:
  SpecialCoordinatesImage() = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  ~SpecialCoordinatesImage() override = default;
 
private:
  PixelContainerPointer m_Buffer{ PixelContainer::New() };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSpecialCoordinatesImage.hxx"
#endif
 
#endif