itkImageAndArray.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkImageAndArray_h
#define itkImageAndArray_h

#include <itkImage.h>
#include <itkArray.h>


namespace itk
{
template <class TPixel, unsigned int VImageDimension=2>
class ITK_EXPORT ImageAndArray : public Image<TPixel, VImageDimension>, public Array<TPixel>
{
public:
  typedef ImageAndArray                    Self;
  typedef Image<TPixel, VImageDimension>   Superclass;
  typedef SmartPointer<Self>           Pointer;
  typedef SmartPointer<const Self>     ConstPointer;
  typedef WeakPointer<const Self>      ConstWeakPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageAndArray, Image);

  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 ImportImageContainer<unsigned long, PixelType> PixelContainer;

  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 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;

  virtual void Initialize();

  virtual void SynchronizeArray();

  TPixel & operator[](const IndexType &index)
  { return this->Image<TPixel, VImageDimension>::GetPixel(index); }

  const TPixel& operator[](const IndexType &index) const
     { return this->Image<TPixel, VImageDimension>::GetPixel(index); }


protected:
  ImageAndArray();
  void PrintSelf(std::ostream& os, Indent indent) const;
  virtual ~ImageAndArray() {};


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

};

} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageAndArray(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT ImageAndArray< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef ImageAndArray< ITK_TEMPLATE_2 x > ImageAndArray##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkImageAndArray+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkImageAndArray.txx"
#endif

#endif