itkVectorImage.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 __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 VectorImage:
  public ImageBase< VImageDimension >
{
public:
  typedef VectorImage                  Self;
  typedef ImageBase< VImageDimension > Superclass;
  typedef SmartPointer< Self >         Pointer;
  typedef SmartPointer< const Self >   ConstPointer;
  typedef WeakPointer< const Self >    ConstWeakPointer;

  itkNewMacro(Self);

  itkTypeMacro(VectorImage, ImageBase);

  typedef VariableLengthVector< TPixel > PixelType;

  typedef TPixel InternalPixelType;

  typedef PixelType ValueType;

  typedef InternalPixelType IOPixelType;

  typedef DefaultVectorPixelAccessor< InternalPixelType > AccessorType;

  typedef DefaultVectorPixelAccessorFunctor< Self > AccessorFunctorType;

  typedef VectorImageNeighborhoodAccessorFunctor<
    Self >              NeighborhoodAccessorFunctorType;

  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);

  typedef typename Superclass::IndexType      IndexType;
  typedef typename Superclass::IndexValueType IndexValueType;

  typedef typename Superclass::OffsetType OffsetType;

  typedef typename Superclass::SizeType      SizeType;

  typedef ImportImageContainer< SizeValueType, InternalPixelType > PixelContainer;

  typedef typename Superclass::DirectionType DirectionType;

  typedef typename Superclass::RegionType RegionType;

  typedef typename Superclass::SpacingType SpacingType;

  typedef typename Superclass::PointType PointType;

  typedef typename PixelContainer::Pointer      PixelContainerPointer;
  typedef typename PixelContainer::ConstPointer PixelContainerConstPointer;

  typedef typename Superclass::OffsetValueType OffsetValueType;

  typedef unsigned int VectorLengthType;

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

  template <typename UElementType, unsigned int UImageDimension>
  struct Rebind< VariableLengthVector< UElementType >, UImageDimension>
  {
    typedef itk::VectorImage<UElementType, UImageDimension>  Type;
  };

  virtual void Allocate(bool UseDefaultConstructor = false) ITK_OVERRIDE;

  virtual void Initialize();

  void FillBuffer(const PixelType & value);

  void SetPixel(const IndexType & index, const PixelType & value)
  {
    OffsetValueType offset = m_VectorLength * this->ComputeOffset(index);

    for ( VectorLengthType i = 0; i < m_VectorLength; i++ )
      {
      ( *m_Buffer )[offset + i] = value[i];
      }
  }

  const PixelType GetPixel(const IndexType & index) const
  {
    OffsetValueType offset = m_VectorLength * this->ComputeOffset(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)
  {
    OffsetValueType offset = m_VectorLength * this->ComputeOffset(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() : ITK_NULLPTR;
  }
  const InternalPixelType * GetBufferPointer() const
  {
    return m_Buffer ? m_Buffer->GetBufferPointer() : ITK_NULLPTR;
  }

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

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

  void SetPixelContainer(PixelContainer *container);

  virtual void Graft(const DataObject *data);

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

  const AccessorType GetPixelAccessor(void) 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);

  virtual unsigned int GetNumberOfComponentsPerPixel() const;

  virtual void SetNumberOfComponentsPerPixel(unsigned int n);

protected:
  VectorImage();
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual ~VectorImage() {}

private:
  VectorImage(const Self &);    // purposely not implementated
  void operator=(const Self &); //purposely not implemented

  VectorLengthType m_VectorLength;

  PixelContainerPointer m_Buffer;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkVectorImage.hxx"
#endif

#endif