#include <itkImageBase.h>

Inheritance diagram for itk::ImageBase< VImageDimension >:

Collaboration diagram for itk::ImageBase< VImageDimension >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Matrix< double, VImageDimension, VImageDimension >	DirectionType
typedef Index< VImageDimension >	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef Offset< VImageDimension >	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef SmartPointer< Self >	Pointer
typedef Point< PointValueType, VImageDimension >	PointType
typedef double	PointValueType
typedef ImageRegion < VImageDimension >	RegionType
typedef ImageBase	Self
typedef Size< VImageDimension >	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef Vector < SpacingValueType, VImageDimension >	SpacingType
typedef double	SpacingValueType
typedef DataObject	Superclass
Public Member Functions
virtual void	Allocate ()
OffsetValueType	ComputeOffset (const IndexType &ind) const
virtual void	CopyInformation (const DataObject *data)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const RegionType &	GetBufferedRegion () const
virtual const DirectionType &	GetDirection ()
virtual const DirectionType &	GetInverseDirection ()
virtual const RegionType &	GetLargestPossibleRegion () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfComponentsPerPixel () const
virtual const PointType &	GetOrigin ()
virtual const RegionType &	GetRequestedRegion () const
virtual const SpacingType &	GetSpacing ()
virtual void	Graft (const DataObject *data)
void	Initialize ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
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	SetOrigin (const float origin[VImageDimension])
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
template<class TCoordRep >
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
template<class TCoordRep >
void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (const double origin[VImageDimension])

const OffsetValueType *	GetOffsetTable () const

IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	SetSpacing (const SpacingType &spacing)
virtual void	SetSpacing (const double spacing[VImageDimension])
virtual void	SetSpacing (const float spacing[VImageDimension])
template<class TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
template<class TCoordRep >
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
template<class TCoordRep >
void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const

template<class TCoordRep >
void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
Static Public Member Functions
static unsigned int	GetImageDimension ()
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension
Protected Member Functions
virtual void	ComputeIndexToPhysicalPointMatrices ()
void	ComputeOffsetTable ()
	ImageBase ()
virtual void	InitializeBufferedRegion (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	~ImageBase ()
Protected Attributes
DirectionType	m_Direction
DirectionType	m_IndexToPhysicalPoint
DirectionType	m_InverseDirection
PointType	m_Origin
DirectionType	m_PhysicalPointToIndex
SpacingType	m_Spacing
Private Member Functions
	ImageBase (const Self &)
void	operator= (const Self &)
Private Attributes
RegionType	m_BufferedRegion
RegionType	m_LargestPossibleRegion
OffsetValueType	m_OffsetTable [VImageDimension+1]
RegionType	m_RequestedRegion

Detailed Description

template<unsigned int VImageDimension = 2>
class itk::ImageBase< VImageDimension >

Base class for templated image classes.

ImageBase is the base class for the templated Image classes. ImageBase is templated over the dimension of the image. It provides the API and ivars that depend solely on the dimension of the image. ImageBase does not store any of the image (pixel) data. Storage for the pixels and the pixel access methods are defined in subclasses of ImageBase, namely Image and ImageAdaptor.

There are three sets of meta-data describing an image. 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, may 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]

Definition at line 95 of file itkImageBase.h.

Member Typedef Documentation

template<unsigned int VImageDimension = 2>

typedef SmartPointer< const Self > itk::ImageBase< VImageDimension >::ConstPointer

Reimplemented from itk::DataObject.

Definition at line 102 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Matrix< double, VImageDimension, VImageDimension > itk::ImageBase< VImageDimension >::DirectionType

Direction typedef support. The Direction is a matix of direction cosines that specify the direction between samples.

Definition at line 148 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Index< VImageDimension > itk::ImageBase< VImageDimension >::IndexType

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

Definition at line 117 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef IndexType::IndexValueType itk::ImageBase< VImageDimension >::IndexValueType

Definition at line 118 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Offset< VImageDimension > itk::ImageBase< VImageDimension >::OffsetType

Offset typedef support. An offset represent relative position between indices.

Definition at line 122 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef OffsetType::OffsetValueType itk::ImageBase< VImageDimension >::OffsetValueType

Definition at line 123 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef SmartPointer< Self > itk::ImageBase< VImageDimension >::Pointer

Reimplemented from itk::DataObject.

Definition at line 101 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Point< PointValueType, VImageDimension > itk::ImageBase< VImageDimension >::PointType

Definition at line 143 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef double itk::ImageBase< VImageDimension >::PointValueType

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 142 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef ImageRegion< VImageDimension > itk::ImageBase< VImageDimension >::RegionType

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

Definition at line 131 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef ImageBase itk::ImageBase< VImageDimension >::Self

Standard typedefs.

Reimplemented from itk::DataObject.

Definition at line 99 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Size< VImageDimension > itk::ImageBase< VImageDimension >::SizeType

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

Definition at line 126 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef SizeType::SizeValueType itk::ImageBase< VImageDimension >::SizeValueType

Definition at line 127 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef Vector< SpacingValueType, VImageDimension > itk::ImageBase< VImageDimension >::SpacingType

Definition at line 138 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef double itk::ImageBase< VImageDimension >::SpacingValueType

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. ITK only supports positive spacing value: negative values may cause undesirable results.

Reimplemented in itk::Image< TPixel, VImageDimension >, and itk::Image< TNode *, VImageDimension >.

Definition at line 137 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

typedef DataObject itk::ImageBase< VImageDimension >::Superclass

Reimplemented from itk::DataObject.

Definition at line 100 of file itkImageBase.h.

Constructor & Destructor Documentation

template<unsigned int VImageDimension = 2>

itk::ImageBase< VImageDimension >::ImageBase ( ) [protected]

template<unsigned int VImageDimension = 2>

itk::ImageBase< VImageDimension >::~ImageBase ( ) [protected]

template<unsigned int VImageDimension = 2>

itk::ImageBase< VImageDimension >::ImageBase ( const Self & ) [private]

Member Function Documentation

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::Allocate ( ) [inline, virtual]

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

This method should be pure virtual, if backwards compatibility was not required.

Definition at line 223 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

IndexType itk::ImageBase< VImageDimension >::ComputeIndex ( OffsetValueType offset ) const [inline]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()).

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >.

Definition at line 332 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::ComputeIndexToPhysicalPointMatrices ( ) [protected, virtual]

Compute helper matrices used to transform Index coordinates to PhysicalPoint coordinates and back. This method is virtual and will be overloaded in derived classes in order to provide backward compatibility behavior in classes that did not used to take image orientation into account.

Reimplemented in itk::Image< TPixel, VImageDimension >, and itk::Image< TNode *, VImageDimension >.

template<unsigned int VImageDimension = 2>

OffsetValueType itk::ImageBase< VImageDimension >::ComputeOffset ( const IndexType & ind ) const [inline]

Compute an offset from the beginning of the buffer for a pixel at the specified index. The index is not checked as to whether it is inside the current buffer, so the computed offset could conceivably be outside the buffer. If bounds checking is needed, one can call ImageRegion::IsInside(ind) on the BufferedRegion prior to calling ComputeOffset.

Definition at line 297 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::ComputeOffsetTable ( ) [protected]

Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is set.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::CopyInformation ( const DataObject * data ) [virtual]

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual::itk::LightObject::Pointer itk::ImageBase< 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::Object.

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetBufferedRegion ( ) const [inline, virtual]

Get the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also:: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Definition at line 250 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const DirectionType& itk::ImageBase< VImageDimension >::GetDirection ( ) [virtual]

Get the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next. For ImageBase and Image, the default direction is identity.

template<unsigned int VImageDimension = 2>

static unsigned int itk::ImageBase< VImageDimension >::GetImageDimension ( ) [inline, static]

Image dimension. The dimension of an image is fixed at construction.

Definition at line 154 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const DirectionType& itk::ImageBase< VImageDimension >::GetInverseDirection ( ) [virtual]

Get the inverse direction cosines of the image. These are calculated automatically in SetDirection, thus there is no Set accessor.

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetLargestPossibleRegion ( ) const [inline, virtual]

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also:: ImageRegion, GetBufferedRegion(), GetRequestedRegion()

Definition at line 239 of file itkImageBase.h.

Referenced by itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask(), and itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage, TFemObjectType >::SetDisplacementField().

template<unsigned int VImageDimension = 2>

virtual const char* itk::ImageBase< VImageDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual unsigned int itk::ImageBase< VImageDimension >::GetNumberOfComponentsPerPixel ( ) const [virtual]

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

 outputImage->SetNumberOfComponentsPerPixel(
    inputImage->GetNumberOfComponentsPerPixel() )

See also:: ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, itk::VectorImage< TPixelType, Dimension >, itk::Image< TPixel, VImageDimension >, and itk::Image< TNode *, VImageDimension >.

template<unsigned int VImageDimension = 2>

const OffsetValueType* itk::ImageBase< VImageDimension >::GetOffsetTable ( ) const [inline]

Get the offset table. The offset table gives increments for moving from one pixel to next in the current row, column, slice, etc.. This table if of size [VImageDimension+1], because its values are computed progressively as: {1, N1, N1*N2, N1*N2*N3,...,(N1*...*Nn)} Where the values {N1,...,Nn} are the elements of the BufferedRegion::Size array. The last element of the OffsetTable is equivalent to the BufferSize. Having a [VImageDimension+1] size array, simplifies the implementation of some data accessing algorithms. The entries in the offset table are only valid after the BufferedRegion is set.

Definition at line 288 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const PointType& itk::ImageBase< VImageDimension >::GetOrigin ( ) [virtual]

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0.

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetRequestedRegion ( ) const [inline, virtual]

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

See also:: ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

Definition at line 275 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const SpacingType& itk::ImageBase< VImageDimension >::GetSpacing ( ) [virtual]

Get the spacing (size of a pixel) `of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::Graft ( const DataObject * data ) [virtual]

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. Subclasses of ImageBase are responsible for copying the pixel container.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::Initialize ( ) [virtual]

Restore object to initialized state.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::InitializeBufferedRegion ( void ) [protected, virtual]

Restores the buffered region to it's default state This method does not call Modify because Initialization is called by ReleaseData and can not modify the MTime

See also:: ReleaseData, Initialize, SetBufferedRegion

template<unsigned int VImageDimension = 2>

static Pointer itk::ImageBase< VImageDimension >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::operator= ( const Self & ) [private]

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual bool itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetBufferedRegion ( const RegionType & region ) [virtual]

Set the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also:: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetDirection ( const DirectionType direction ) [virtual]

Set the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next.

One row of the matrix indicates the direction cosines of the unit vector that is parallel to the lines of the image grid corresponding to that dimension. For example, and image with Direction matrix

0.866 0.500 -0.500 0.866

has an image grid were the fastest changing index (dimension[0]) walks over a line that in Physical space is oriented parallel to the vector (0.866,0.5). The second fastest changing index (dimension[1]) walks along a line that in Physical space is oriented parallel to the vector (-0.5,0.866)

The vectors whose direction cosines are stored in the Direction matrix, are expected to be orthogonal to each other, and they are expected to form a right handed coordinate system, but this is not checked nor enforced in the itk::ImageBase.

For details, please see:

http://www.itk.org/Wiki/Proposals:Orientation#Some_notes_on_the_DICOM_convention_and_current_ITK_usage

See also:: GetDirection()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetLargestPossibleRegion ( const RegionType & region ) [virtual]

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also:: ImageRegion, SetBufferedRegion(), SetRequestedRegion()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int ) [virtual]

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( PointType _arg ) [virtual]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const double origin[VImageDimension] ) [virtual]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

Reimplemented in itk::SpecialCoordinatesImage< TPixel, VImageDimension >, and itk::SpecialCoordinatesImage< TPixel, 3 >.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const float origin[VImageDimension] ) [virtual]

Reimplemented in itk::SpecialCoordinatesImage< TPixel, VImageDimension >, and itk::SpecialCoordinatesImage< TPixel, 3 >.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegion ( const RegionType & region ) [virtual]

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

See also:: ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegion ( const DataObject * data ) [virtual]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase. Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegionToLargestPossibleRegion ( ) [virtual]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const SpacingType & spacing ) [virtual]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. These methods also pre-compute the Index to Physical point transforms of the image.

See also:: GetSpacing()

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const double spacing[VImageDimension] ) [virtual]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()).

Reimplemented in itk::SpecialCoordinatesImage< TPixel, VImageDimension >, and itk::SpecialCoordinatesImage< TPixel, 3 >.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const float spacing[VImageDimension] ) [virtual]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()).

Reimplemented in itk::SpecialCoordinatesImage< TPixel, VImageDimension >, and itk::SpecialCoordinatesImage< TPixel, 3 >.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformContinuousIndexToPhysicalPoint	(	const ContinuousIndex< TCoordRep, VImageDimension > &	index,
		Point< TCoordRep, VImageDimension > &	point
	)		const `[inline]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a continuous index (in the index space)

See also:: Transform

Definition at line 444 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformIndexToPhysicalPoint	(	const IndexType &	index,
		Point< TCoordRep, VImageDimension > &	point
	)		const `[inline]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See also:: Transform

Definition at line 466 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector	(	const FixedArray< TCoordRep, VImageDimension > &	inputGradient,
		FixedArray< TCoordRep, VImageDimension > &	outputGradient
	)		const `[inline]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See also:: Transform Take a vector or covariant vector that has been computed in the coordinate system parallel to the image grid and rotate it by the direction cosines in order to get it in terms of the coordinate system of the image acquisition device. This implementation in the Image multiply the array (vector or covariant vector) by the matrix of Direction Cosines. The arguments of the method are of type FixedArray to make possible to use this method with both Vector and CovariantVector. The Method is implemented differently in the itk::Image.; Image

Definition at line 510 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToContinuousIndex	(	const Point< TCoordRep, VImageDimension > &	point,
		ContinuousIndex< TCoordRep, VImageDimension > &	index
	)		const `[inline]`

Get the continuous index from a physical point.

Returns true if the resulting index is within the image, false otherwise.

See also:: Transform

Definition at line 417 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToIndex	(	const Point< TCoordRep, VImageDimension > &	point,
		IndexType &	index
	)		const `[inline]`

Get the index (discrete) of a voxel from a physical point. Floating point index results are rounded to integers Returns true if the resulting index is within the image, false otherwise

See also:: Transform

Definition at line 379 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformPhysicalVectorToLocalVector	(	const FixedArray< TCoordRep, VImageDimension > &	inputGradient,
		FixedArray< TCoordRep, VImageDimension > &	outputGradient
	)		const `[inline]`

Take a vector or covariant vector that has been computed in terms of the coordinate system of the image acquisition device, and rotate it by the inverse direction cosines in order to get it in the coordinate system parallel to the image grid. This implementation in the Image multiply the array (vector or covariant vector) by the inverse of Direction Cosines. The arguments of the method are of type FixedArray to make possible to use this method with both Vector and CovariantVector.

Definition at line 541 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::UpdateOutputData ( ) [virtual]

Overriden from base class to check if the requested image region has zero pixels.

This is needed so that filters can set an input's requested region to zero, to indicate that it does not need to be updated or executed.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::UpdateOutputInformation ( ) [virtual]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. This method calls its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual bool itk::ImageBase< VImageDimension >::VerifyRequestedRegion ( ) [virtual]

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion.

Reimplemented from itk::DataObject.

Member Data Documentation

template<unsigned int VImageDimension = 2>

const unsigned int itk::ImageBase< 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 114 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_BufferedRegion [private]

Definition at line 698 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_Direction [protected]

Definition at line 676 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_IndexToPhysicalPoint [protected]

Matrices intended to help with the conversion of Index coordinates to PhysicalPoint coordinates

Definition at line 681 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_InverseDirection [protected]

Definition at line 677 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_LargestPossibleRegion [private]

Definition at line 696 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

OffsetValueType itk::ImageBase< VImageDimension >::m_OffsetTable[VImageDimension+1] [private]

Definition at line 694 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

PointType itk::ImageBase< VImageDimension >::m_Origin [protected]

Definition at line 674 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex [protected]

Definition at line 682 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_RequestedRegion [private]

Definition at line 697 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

SpacingType itk::ImageBase< VImageDimension >::m_Spacing [protected]

Origin and spacing of physical coordinates. This variables are protected for efficiency. They are referenced frequently by inner loop calculations.

Definition at line 672 of file itkImageBase.h.

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

itkImageBase.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<unsigned int VImageDimension = 2> class itk::ImageBase< VImageDimension >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned int VImageDimension = 2>
class itk::ImageBase< VImageDimension >