itkNDImageTemplate.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkNDImageTemplate_h
#define itkNDImageTemplate_h
 
#include "itkNDImageBase.h"
#include "itkImageFileReader.h"
#include <algorithm>   // For copy_n.
#include <type_traits> // For is_same_v.
 
namespace itk
{

 
template <typename TPixel, unsigned int VDimension>
class ITK_TEMPLATE_EXPORT NDImageTemplate : public NDImageBase<TPixel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NDImageTemplate);

  using Self = NDImageTemplate;
  using Superclass = NDImageBase<TPixel>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(NDImageTemplate);

 
  itkStaticConstMacro(Dimension, unsigned int, VDimension);
 
  using typename Superclass::DataObjectPointer;

  using typename Superclass::PixelType;
  using typename Superclass::ValueType;
  using typename Superclass::InternalPixelType;
  using typename Superclass::AccessorType;
  using typename Superclass::PixelContainer;
  using typename Superclass::PixelContainerPointer;
  using typename Superclass::PixelContainerConstPointer;
 
  using typename Superclass::SpacingValueType;
  using typename Superclass::PointValueType;
  using typename Superclass::OffsetValueType;

  using typename Superclass::IndexType;
  using typename Superclass::SizeType;
  using typename Superclass::SpacingType;
  using typename Superclass::PointType;
  using typename Superclass::OffsetType;

  using ImageType = Image<TPixel, VDimension>;
  using ImagePointer = typename ImageType::Pointer;
  using WriterType = ImageFileWriter<ImageType>;
  using WriterPointer = typename WriterType::Pointer;
  using ReaderType = ImageFileReader<ImageType>;
  using ReaderPointer = typename ReaderType::Pointer;

  using IndexTypeD = typename ImageType::IndexType;
  using SizeTypeD = typename ImageType::SizeType;
  using SpacingTypeD = typename ImageType::SpacingType;
  using PointTypeD = typename ImageType::PointType;
  using OffsetTypeD = typename ImageType::OffsetType;
 
  void
  SetRegions(SizeType size) override;
 
  void
  SetRequestedRegion(DataObject * data) override;
 
  void
  Allocate() override;
 
  void
  Initialize() override;
 
  void
  FillBuffer(const TPixel & value) override;
 
  void
  SetPixel(const IndexType & index, const TPixel & value) override;
 
  const TPixel &
  GetPixel(const IndexType & index) const override;
 
  TPixel &
  GetPixel(const IndexType & index) override;
 
  TPixel *
  GetBufferPointer() override;
 
  const TPixel *
  GetBufferPointer() const override;
 
  PixelContainer *
  GetPixelContainer() override;
 
  const PixelContainer *
  GetPixelContainer() const override;
 
  void
  SetPixelContainer(PixelContainer * container) override;
 
  AccessorType
  GetPixelAccessor() override;
 
  const AccessorType
  GetPixelAccessor() const override;
 
  void
  SetSpacing(const SpacingType & spacing) override;
 
  void
  SetOrigin(const PointType & origin) override;
 
  SpacingType
  GetSpacing() override;
 
  PointType
  GetOrigin() override;

 
  void
  CopyInformation(const DataObject * data) override;
 
  const OffsetValueType *
  GetOffsetTable() const override;
 
  OffsetValueType
  ComputeOffset(const IndexType & ind) const override;
 
  IndexType
  ComputeIndex(OffsetValueType offset) const override;


  unsigned int
  ImageDimension() override;
 
  unsigned int
  GetImageDimension() override;

  itkGetModifiableObjectMacro(Image, DataObject);
  itkGetModifiableObjectMacro(Writer, ProcessObject);
  itkGetModifiableObjectMacro(Reader, ProcessObject);

  void
  Write() override;

  void
  Read() override;

  void
  CreateNewImage() override;
 
  void
  SetImageIOWriter(ImageIOBase * _arg) override;
 
  ImageIOBase *
  GetImageIOWriter() override;
 
  void
  SetImageIOReader(ImageIOBase * _arg) override;
 
  ImageIOBase *
  GetImageIOReader() override;

  void
  SetOutputFileName(const char * name) override;
 
  void
  SetInputFileName(const char * name) override;
 
  const char *
  GetOutputFileName() override;
 
  const char *
  GetInputFileName() override;
 
protected:
  NDImageTemplate() = default;
  ~NDImageTemplate() override = default;
 
  // virtual void PrintSelf(std::ostream& os, Indent indent) const;
 
private:
  ImagePointer  m_Image{ nullptr };
  WriterPointer m_Writer{ nullptr };
  ReaderPointer m_Reader{ nullptr };
 
  template <typename TIn, typename TOut>
  static TOut
  ConvertToDynamicArray(const TIn & in)
  {
    static_assert(TIn().size() == VDimension);
    static_assert(std::is_same_v<decltype(TIn().data()), typename TOut::ValueType *>);
 
    return TOut(in.data(), VDimension);
  }
 
  template <typename TIn, typename TOut>
  static TOut
  ConvertToStaticArray(const TIn & in)
  {
    // Note: It is assumed here that `in.size()` is also equal to VDimension.
    static_assert(TOut().size() == VDimension);
    static_assert(std::is_same_v<decltype(*(TIn().begin())), decltype(*(TOut().begin()))>);
 
    TOut out;
    std::copy_n(in.begin(), VDimension, out.begin());
    return out;
  }
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNDImageTemplate.hxx"
#endif
 
#endif // end #ifndef itkNDImageTemplate_h