itkVectorImage.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 itkVectorImage_h
#define itkVectorImage_h
 
#include "itkImageRegion.h"
#include "itkImportImageContainer.h"
#include "itkDefaultVectorPixelAccessor.h"
#include "itkDefaultVectorPixelAccessorFunctor.h"
#include "itkVectorImageNeighborhoodAccessorFunctor.h"
#include "itkWeakPointer.h"
 
namespace itk
{
template <typename TPixel, unsigned int VImageDimension = 3>
class ITK_TEMPLATE_EXPORT VectorImage : public ImageBase<VImageDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VectorImage);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VectorImage);

  using PixelType = VariableLengthVector<TPixel>;

  using InternalPixelType = TPixel;

  using ValueType = PixelType;
 
  using IOPixelType = InternalPixelType;

  using AccessorType = DefaultVectorPixelAccessor<InternalPixelType>;

  using AccessorFunctorType = DefaultVectorPixelAccessorFunctor<Self>;

  using NeighborhoodAccessorFunctorType = VectorImageNeighborhoodAccessorFunctor<Self>;

  static constexpr unsigned int ImageDimension = VImageDimension;

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

  using typename Superclass::OffsetType;

  using typename Superclass::SizeType;

  using PixelContainer = ImportImageContainer<SizeValueType, InternalPixelType>;

  using typename Superclass::DirectionType;

  using typename Superclass::RegionType;

  using typename Superclass::SpacingType;

  using typename Superclass::PointType;

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

  using typename Superclass::OffsetValueType;
 
  using VectorLengthType = unsigned int;

  template <typename UPixelType, unsigned int VUImageDimension = VImageDimension>
  struct Rebind
  {
    using Type = itk::VectorImage<UPixelType, VUImageDimension>;
  };

  template <typename UElementType, unsigned int VUImageDimension>
  struct Rebind<VariableLengthVector<UElementType>, VUImageDimension>
  {
    using Type = itk::VectorImage<UElementType, VUImageDimension>;
  };
 
  template <typename UPixelType, unsigned int VUImageDimension = VImageDimension>
  using RebindImageType = typename Rebind<UPixelType, VUImageDimension>::Type;

  void
  Allocate(bool UseValueInitialization = false) override;

  void
  Initialize() override;

  void
  FillBuffer(const PixelType & value);

  void
  SetPixel(const IndexType & index, const PixelType & value)
  {
    const OffsetValueType offset = m_VectorLength * this->FastComputeOffset(index);
 
    for (VectorLengthType i = 0; i < m_VectorLength; ++i)
    {
      (*m_Buffer)[offset + i] = value[i];
    }
  }

  const PixelType
  GetPixel(const IndexType & index) const
  {
    const OffsetValueType offset = m_VectorLength * this->FastComputeOffset(index);
 
    // Do not create a local for this method, to use return value
    // optimization.
    return PixelType(&((*m_Buffer)[offset]), m_VectorLength);
  }

  PixelType
  GetPixel(const IndexType & index)
  {
    const OffsetValueType offset = m_VectorLength * this->FastComputeOffset(index);
 
    // Correctness of this method relies of return value optimization, do
    // not create a local for the value.
    return PixelType(&((*m_Buffer)[offset]), m_VectorLength);
  }

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

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

  InternalPixelType *
  GetBufferPointer()
  {
    return m_Buffer ? m_Buffer->GetBufferPointer() : nullptr;
  }
  const InternalPixelType *
  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);

  virtual void
  Graft(const Self * image);

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

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

  NeighborhoodAccessorFunctorType
  GetNeighborhoodAccessor()
  {
    return NeighborhoodAccessorFunctorType(m_VectorLength);
  }

  const NeighborhoodAccessorFunctorType
  GetNeighborhoodAccessor() const
  {
    return NeighborhoodAccessorFunctorType(m_VectorLength);
  }

  itkSetMacro(VectorLength, VectorLengthType);
  itkGetConstReferenceMacro(VectorLength, VectorLengthType);

  unsigned int
  GetNumberOfComponentsPerPixel() const override;
 
  void
  SetNumberOfComponentsPerPixel(unsigned int n) override;
 
protected:
  VectorImage() = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  ~VectorImage() override = default;
  void
  Graft(const DataObject * data) override;
  using Superclass::Graft;
 
private:
  VectorLengthType m_VectorLength{ 0 };

  PixelContainerPointer m_Buffer{ PixelContainer::New() };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVectorImage.hxx"
#endif
 
#endif