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< class TPixel, unsigned int VImageDimension = 2 >
class ITK_EXPORT Image:public ImageBase< VImageDimension >
{
public:
  typedef Image                        Self;
  typedef ImageBase< VImageDimension > Superclass;
  typedef SmartPointer< Self >         Pointer;
  typedef SmartPointer< const Self >   ConstPointer;
  typedef WeakPointer< const Self >    ConstWeakPointer;

  itkNewMacro(Self);

  itkTypeMacro(Image, ImageBase);

  typedef TPixel PixelType;

  typedef TPixel ValueType;

  typedef TPixel InternalPixelType;

  typedef PixelType IOPixelType;

  typedef DefaultPixelAccessor< PixelType >   AccessorType;
  typedef DefaultPixelAccessorFunctor< Self > AccessorFunctorType;

  typedef NeighborhoodAccessorFunctor< 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 typename Superclass::SizeValueType SizeValueType;

  typedef ImportImageContainer< SizeValueType, PixelType > PixelContainer;

  typedef typename Superclass::DirectionType DirectionType;

  typedef typename Superclass::RegionType RegionType;

  typedef typename Superclass::SpacingType      SpacingType;
  typedef typename Superclass::SpacingValueType SpacingValueType;

  typedef typename Superclass::PointType PointType;

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

  typedef typename Superclass::OffsetValueType OffsetValueType;

  void Allocate();

  void SetRegions(RegionType region)
  {
    this->SetLargestPossibleRegion(region);
    this->SetBufferedRegion(region);
    this->SetRequestedRegion(region);
  }

  void SetRegions(SizeType size)
  {
    RegionType region; region.SetSize(size);

    this->SetLargestPossibleRegion(region);
    this->SetBufferedRegion(region);
    this->SetRequestedRegion(region);
  }

  virtual void Initialize();

  void FillBuffer(const TPixel & value);

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

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

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

  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(); }

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

  NeighborhoodAccessorFunctorType GetNeighborhoodAccessor()
  { return NeighborhoodAccessorFunctorType(); }

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

  virtual unsigned int GetNumberOfComponentsPerPixel() const;

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

  virtual ~Image() {}

  virtual void ComputeIndexToPhysicalPointMatrices();

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

  PixelContainerPointer m_Buffer;
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Image(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                         \
  {                                                     \
  _( 2 ( class EXPORT Image< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                   \
  {                                                     \
  typedef Image< ITK_TEMPLATE_2 TypeX > Image##TypeY; \
  }                                                     \
  }

#if ITK_TEMPLATE_EXPLICIT
//template <class TPixel, unsigned int VImageDimension> const unsigned int
// itk::Image<TPixel,VImageDimension>::ImageDimension;
#include "Templates/itkImage+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkImage.hxx"
#endif

#endif