itkSpecialCoordinatesImage.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 __itkSpecialCoordinatesImage_h
#define __itkSpecialCoordinatesImage_h

#include "itkImageBase.h"
#include "itkImportImageContainer.h"
#include "itkDefaultPixelAccessor.h"
#include "itkDefaultPixelAccessorFunctor.h"
#include "itkContinuousIndex.h"

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

  itkNewMacro(Self);

  itkTypeMacro(SpecialCoordinatesImage, ImageBase);

  typedef TPixel PixelType;

  typedef TPixel ValueType;

  typedef TPixel InternalPixelType;

  typedef PixelType IOPixelType;

  typedef DefaultPixelAccessor< PixelType > AccessorType;

  typedef DefaultPixelAccessorFunctor< Self > AccessorFunctorType;

  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);

  typedef typename Superclass::IndexType IndexType;

  typedef typename Superclass::OffsetType OffsetType;

  typedef typename Superclass::SizeType      SizeType;

  typedef ImportImageContainer< SizeValueType, PixelType > PixelContainer;

  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;

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

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

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

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

  virtual void SetSpacing(const SpacingType &) {}
  virtual void SetSpacing(const double[VImageDimension]) {}
  virtual void SetSpacing(const float[VImageDimension]) {}
  virtual void SetOrigin(const PointType) {}
  virtual void SetOrigin(const double[VImageDimension]) {}
  virtual void SetOrigin(const float[VImageDimension]) {}

  /* It is ILLEGAL in C++ to make a templated member function virtual! */
  /* Therefore, we must just let templates take care of everything.    */
  /*
  template<class TCoordRep>
  virtual bool TransformPhysicalPointToContinuousIndex(
              const Point<TCoordRep, VImageDimension>& point,
              ContinuousIndex<TCoordRep, VImageDimension>& index   ) const = 0;

  template<class TCoordRep>
  virtual bool TransformPhysicalPointToIndex(
            const Point<TCoordRep, VImageDimension>&,
            IndexType & index                                ) const = 0;

  template<class TCoordRep>
  virtual void TransformContinuousIndexToPhysicalPoint(
            const ContinuousIndex<TCoordRep, VImageDimension>& index,
            Point<TCoordRep, VImageDimension>& point        ) const = 0;

  template<class TCoordRep>
  virtual void TransformIndexToPhysicalPoint(
                      const IndexType & index,
                      Point<TCoordRep, VImageDimension>& point ) const = 0;
  */
protected:
  SpecialCoordinatesImage();
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual ~SpecialCoordinatesImage() {}
private:
  SpecialCoordinatesImage(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_SpecialCoordinatesImage(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                           \
  {                                                                       \
  _( 2 ( class EXPORT SpecialCoordinatesImage< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                     \
  {                                                                       \
  typedef SpecialCoordinatesImage< ITK_TEMPLATE_2 TypeX >                 \
  SpecialCoordinatesImage##TypeY;                                       \
  }                                                                       \
  }

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

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

#endif