Orfeo Toolbox  4.2
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::SpecialCoordinatesImage< TPixel, VImageDimension > Class Template Reference

Templated n-dimensional nonrectilinear-coordinate image base class. More...

#include <itkSpecialCoordinatesImage.h>

+ Inheritance diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:
+ Collaboration diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:

Public Types

typedef
DefaultPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef DefaultPixelAccessor
< PixelType
AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::IndexType IndexType
 
typedef TPixel InternalPixelType
 
typedef PixelType IOPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef ImportImageContainer
< SizeValueType, PixelType
PixelContainer
 
typedef
PixelContainer::ConstPointer 
PixelContainerConstPointer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TPixel PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
typedef SpecialCoordinatesImage Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SpacingType SpacingType
 
typedef ImageBase
< VImageDimension > 
Superclass
 
typedef TPixel ValueType
 
- Public Types inherited from itk::ImageBase< VImageDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Matrix
< SpacePrecisionType,
VImageDimension,
VImageDimension > 
DirectionType
 
typedef Index< VImageDimension > IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef Offset< VImageDimension > OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef SmartPointer< SelfPointer
 
typedef Point< PointValueType,
VImageDimension > 
PointType
 
typedef SpacePrecisionType PointValueType
 
typedef ImageRegion
< VImageDimension > 
RegionType
 
typedef ImageBase Self
 
typedef Size< VImageDimension > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef Vector
< SpacingValueType,
VImageDimension > 
SpacingType
 
typedef SpacePrecisionType SpacingValueType
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void Allocate (bool initialize=false) ITK_OVERRIDE
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FillBuffer (const TPixel &value)
 
TPixel * GetBufferPointer ()
 
const TPixel * GetBufferPointer () const
 
virtual const char * GetNameOfClass () const
 
const TPixel & GetPixel (const IndexType &index) const
 Get a pixel (read only version). More...
 
TPixel & GetPixel (const IndexType &index)
 Get a reference to a pixel (e.g. for editing). More...
 
AccessorType GetPixelAccessor (void)
 
const AccessorType GetPixelAccessor (void) const
 
PixelContainerGetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual void Initialize ()
 
TPixel & operator[] (const IndexType &index)
 Access a pixel. This version can be an lvalue. More...
 
const TPixel & operator[] (const IndexType &index) const
 Access a pixel. This version can only be an rvalue. More...
 
virtual void SetOrigin (const PointType)
 
virtual void SetOrigin (const double[VImageDimension])
 
virtual void SetOrigin (const float[VImageDimension])
 
void SetPixel (const IndexType &index, const TPixel &value)
 Set a pixel value. More...
 
void SetPixelContainer (PixelContainer *container)
 
virtual void SetSpacing (const SpacingType &)
 
virtual void SetSpacing (const double[VImageDimension])
 
virtual void SetSpacing (const float[VImageDimension])
 
- Public Member Functions inherited from itk::ImageBase< VImageDimension >
IndexType ComputeIndex (OffsetValueType offset) const
 
OffsetValueType ComputeOffset (const IndexType &ind) const
 
virtual void CopyInformation (const DataObject *data) ITK_OVERRIDE
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual const DirectionTypeGetDirection ()
 
virtual const DirectionTypeGetInverseDirection ()
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
const OffsetValueTypeGetOffsetTable () const
 
virtual const PointTypeGetOrigin ()
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const SpacingTypeGetSpacing ()
 
virtual void Graft (const DataObject *data) ITK_OVERRIDE
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () ITK_OVERRIDE
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual void SetDirection (const DirectionType &direction)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual void SetNumberOfComponentsPerPixel (unsigned int)
 
virtual void SetRegions (const RegionType &region)
 
virtual void SetRegions (const SizeType &size)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (const DataObject *data) ITK_OVERRIDE
 
virtual void SetRequestedRegionToLargestPossibleRegion () ITK_OVERRIDE
 
template<typename TCoordRep , typename TIndexRep >
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep >
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
template<typename TCoordRep , typename TIndexRep >
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const
 Get the continuous index from a physical point. More...
 
template<typename TCoordRep >
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
template<typename TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
virtual void UpdateOutputData () ITK_OVERRIDE
 
virtual void UpdateOutputInformation () ITK_OVERRIDE
 
virtual bool VerifyRequestedRegion () ITK_OVERRIDE
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime ()
 
virtual const RealTimeStampGetRealTimeStamp ()
 
virtual const bool & GetReleaseDataFlag ()
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName ()
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageBase< VImageDimension >
static unsigned int GetImageDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

 SpecialCoordinatesImage ()
 
virtual ~SpecialCoordinatesImage ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
- Protected Member Functions inherited from itk::ImageBase< VImageDimension >
 ImageBase ()
 
 ~ImageBase ()
 
virtual void ComputeIndexToPhysicalPointMatrices ()
 
void ComputeOffsetTable ()
 
virtual void InitializeBufferedRegion (void)
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
 ~DataObject ()
 
virtual void PropagateResetPipeline ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
virtual ~Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual ~LightObject ()
 
virtual LightObject::Pointer InternalClone () const
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Private Member Functions

 SpecialCoordinatesImage (const Self &)
 
void operator= (const Self &)
 

Private Attributes

PixelContainerPointer m_Buffer
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ImageBase< VImageDimension >
DirectionType m_Direction
 
DirectionType m_IndexToPhysicalPoint
 
DirectionType m_InverseDirection
 
PointType m_Origin
 
DirectionType m_PhysicalPointToIndex
 
SpacingType m_Spacing
 

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::SpecialCoordinatesImage< TPixel, VImageDimension >

Templated n-dimensional nonrectilinear-coordinate image base class.

SpecialCoordinatesImages are templated over a pixel type (modeling the dependent variables), and a dimension (number of independent variables). The container for the pixel data is the ImportImageContainer.

Within the pixel container, images are modelled as arrays, defined by a start index and a size.

Almost arbitrary mappings between index space & Cartesian physical space are possible, and so m_Origin and m_Spacing should be ignored. They exist only to allow the possibility of running a "spatially-aware" filter in raw index space, as if the SpecialCoordinatesImage data was laid out on a regular grid. Note that this may or may not produce useful results, and it is up the the user to determine the appropriateness of running a filter designed for normal images on special-coordinates images.

The only correct generic method for operating on a SpecialCoordinatesImage in physical space is to use the virtual functions TransformPhysicalPointToIndex, TransformPhysicalPointToContinuousIndex, TransformIndexToPhysicalPoint, and TransformContinuousIndexToPhysicalPoint. All of these methods transform points in Cartesian physical space to and from indices in the special (typically non-Cartesian) index space. It is also possible to check the type of coordinate representation being used by a SpecialCoordinatesImage, and then use representation-specific code to speed up the filter for certain coordinate representations, falling back to the generic method for unrecognized and/or unoptimized coordinate representations.

There are three sets of meta-data describing portions of a SpecialCoordinatesImages. These are "Region" objects that define a portion of an image via a starting index for the image array and a size. The ivar LargestPossibleRegion defines the size and starting index of the image dataset. The entire image dataset, however, need not be resident in memory. The region of the image that is resident in memory is defined by the "BufferedRegion". The Buffer is a contiguous block of memory. The third set of meta-data defines a region of interest, called the "RequestedRegion". The RequestedRegion is used by the pipeline execution model to define what a filter is requested to produce.

[RegionIndex, RegionSize] C [BufferIndex, BufferSize] C [ImageIndex, ImageSize]

Pixels can be accessed direcly using the SetPixel() and GetPixel() methods or can be accessed via iterators. Begin() creates an iterator that can walk a specified region of a buffer.

The pixel type may be one of the native types; a Insight-defined class type such as Vector; or a user-defined type. Note that depending on the type of pixel that you use, the process objects (i.e., those filters processing data objects) may not operate on the image and/or pixel type. This becomes apparent at compile-time because operator overloading (for the pixel type) is not supported.

The data in an image is arranged in a 1D array as [][][][slice][row][col] with the column index varying most rapidly. The Index type reverses the order so that with Index[0] = col, Index[1] = row, Index[2] = slice, ...

See Also
ImageContainerInterface
Image

Definition at line 95 of file itkSpecialCoordinatesImage.h.

Member Typedef Documentation

template<typename TPixel, unsigned int VImageDimension = 2>
typedef DefaultPixelAccessorFunctor< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorFunctorType

Accessor functor to choose between accessors: DefaultPixelAccessor for the Image, and DefaultVectorPixelAccessor for the vector image. The functor provides a generic API between the two accessors.

Definition at line 133 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef DefaultPixelAccessor< PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 128 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef SmartPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstPointer

Definition at line 102 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef WeakPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstWeakPointer

Definition at line 103 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::IndexType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 142 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::InternalPixelType

Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation.

Definition at line 122 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef PixelType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IOPixelType

Definition at line 124 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::OffsetType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values.

Definition at line 145 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef ImportImageContainer< SizeValueType, PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Definition at line 151 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef PixelContainer::ConstPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerConstPointer

Definition at line 169 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef PixelContainer::Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Definition at line 168 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations.

Definition at line 109 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef SmartPointer< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Pointer

Definition at line 101 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::PointType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PointType

Origin typedef support. The origin is the "fake" geometric coordinates of the index (0,0). Also for use w/ filters designed for normal images.

Definition at line 165 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::RegionType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image.

Definition at line 155 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef SpecialCoordinatesImage itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Self

Standard class typedefs

Definition at line 99 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::SizeType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 148 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef Superclass::SpacingType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpacingType

Spacing typedef support. Spacing holds the "fake" size of a pixel, making each pixel look like a 1 unit hyper-cube to filters that were designed for normal images and that therefore use m_Spacing. The spacing is the geometric distance between image samples.

Definition at line 161 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef ImageBase< VImageDimension > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Superclass

Definition at line 100 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 116 of file itkSpecialCoordinatesImage.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int VImageDimension>
itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage ( )
protected

Definition at line 38 of file itkSpecialCoordinatesImage.hxx.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual itk::SpecialCoordinatesImage< TPixel, VImageDimension >::~SpecialCoordinatesImage ( )
inlineprotectedvirtual

Definition at line 286 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage ( const Self )
private

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Allocate ( bool  initialize = false)
virtual

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 46 of file itkSpecialCoordinatesImage.hxx.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixel, unsigned int VImageDimension>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::FillBuffer ( const TPixel &  value)

Fill the image buffer with a value. Be sure to call Allocate() first.

Definition at line 78 of file itkSpecialCoordinatesImage.hxx.

template<typename TPixel, unsigned int VImageDimension = 2>
TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( )
inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 228 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
const TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( ) const
inline

Definition at line 229 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual const char* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

template<typename TPixel, unsigned int VImageDimension = 2>
const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType index) const
inline

Get a pixel (read only version).

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 198 of file itkSpecialCoordinatesImage.h.

Referenced by itk::SpecialCoordinatesImage< TPixel, 3 >::operator[]().

template<typename TPixel, unsigned int VImageDimension = 2>
TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType index)
inline

Get a reference to a pixel (e.g. for editing).

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 208 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( void  )
inline

Return the Pixel Accessor object

Definition at line 241 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
const AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( void  ) const
inline

Return the Pixel Accesor object

Definition at line 244 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( )
inline

Return a pointer to the container.

Definition at line 232 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
const PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( ) const
inline

Definition at line 234 of file itkSpecialCoordinatesImage.h.

template<typename TPixel , unsigned int VImageDimension>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Initialize ( void  )
virtual

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 59 of file itkSpecialCoordinatesImage.hxx.

template<typename TPixel, unsigned int VImageDimension = 2>
static Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::New ( )
static

Method for creation through the object factory.

template<typename TPixel, unsigned int VImageDimension = 2>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator= ( const Self )
private
template<typename TPixel, unsigned int VImageDimension = 2>
TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType index)
inline

Access a pixel. This version can be an lvalue.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 218 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType index) const
inline

Access a pixel. This version can only be an rvalue.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 224 of file itkSpecialCoordinatesImage.h.

template<typename TPixel , unsigned int VImageDimension>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 104 of file itkSpecialCoordinatesImage.hxx.

References itk::Indent::GetNextIndent().

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const PointType  _arg)
inlinevirtual

Set the origin of the image. The origin is the geometric coordinates of the image origin (pixel [0,0]). It is stored internally as SpacePrecisionType but may be set from float or double.

See Also
GetOrigin()

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 254 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const double  [VImageDimension])
inlinevirtual

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 255 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const float  [VImageDimension])
inlinevirtual

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 256 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixel ( const IndexType index,
const TPixel &  value 
)
inline

Set a pixel value.

Allocate() needs to have been called first – for efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 188 of file itkSpecialCoordinatesImage.h.

template<typename TPixel , unsigned int VImageDimension>
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixelContainer ( PixelContainer container)

Set the container to use. Note that this does not cause the DataObject to be modified.

Definition at line 92 of file itkSpecialCoordinatesImage.hxx.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const SpacingType )
inlinevirtual

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 251 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const double  [VImageDimension])
inlinevirtual

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 252 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const float  [VImageDimension])
inlinevirtual

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 253 of file itkSpecialCoordinatesImage.h.

Member Data Documentation

template<typename TPixel, unsigned int VImageDimension = 2>
const unsigned int itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Definition at line 139 of file itkSpecialCoordinatesImage.h.

template<typename TPixel, unsigned int VImageDimension = 2>
PixelContainerPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::m_Buffer
private

The documentation for this class was generated from the following files:

Generated at Sat Oct 11 2014 17:00:14 for Orfeo Toolbox with doxygen 1.8.3.1