itkImage.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 itkImage_h
#define itkImage_h

#include "itkImageRegion.h"
#include "itkImportImageContainer.h"
#include "itkDefaultPixelAccessor.h"
#include "itkDefaultPixelAccessorFunctor.h"
#include "itkPoint.h"
#include "itkFixedArray.h"
#include "itkWeakPointer.h"
#include "itkNeighborhoodAccessorFunctor.h"

namespace itk
{
template< typename TPixel, unsigned int VImageDimension = 2 >
class ITK_TEMPLATE_EXPORT Image:public ImageBase< VImageDimension >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(Image);

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

  itkNewMacro(Self);

  itkTypeMacro(Image, ImageBase);

  using PixelType = TPixel;

  using ValueType = TPixel;

  using InternalPixelType = TPixel;

  using IOPixelType = PixelType;

  using AccessorType = DefaultPixelAccessor< PixelType >;
  using AccessorFunctorType = DefaultPixelAccessorFunctor< Self >;

  using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor< Self >;

  using ImageDimensionType = typename Superclass::ImageDimensionType;

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

  using OffsetType = typename Superclass::OffsetType;

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

  using PixelContainer = ImportImageContainer< SizeValueType, PixelType >;

  using DirectionType = typename Superclass::DirectionType;

  using RegionType = typename Superclass::RegionType;

  using SpacingType = typename Superclass::SpacingType;
  using SpacingValueType = typename Superclass::SpacingValueType;

  using PointType = typename Superclass::PointType;

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

  using OffsetValueType = typename Superclass::OffsetValueType;

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


  template <typename UPixelType, unsigned int NUImageDimension = VImageDimension>
    using RebindImageType = itk::Image<UPixelType, NUImageDimension>;


  void Allocate(bool initializePixels = false) override;

  void Initialize() override;

  void FillBuffer(const TPixel & value);

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

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

  TPixel & GetPixel(const IndexType & index)
  {
    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); }

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

  virtual void Graft(const Self *data);

  AccessorType GetPixelAccessor()
  { return AccessorType(); }

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

  NeighborhoodAccessorFunctorType GetNeighborhoodAccessor()
  { return NeighborhoodAccessorFunctorType(); }

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

  unsigned int GetNumberOfComponentsPerPixel() const override;

protected:
  Image();
  void PrintSelf(std::ostream & os, Indent indent) const override;
  void Graft(const DataObject *data) override;

  ~Image() override = default;

  void ComputeIndexToPhysicalPointMatrices() override;
  using Superclass::Graft;
private:

  PixelContainerPointer m_Buffer;
};
} // end namespace itk

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

#endif