#include <itkImageBase.h>

Inheritance diagram for itk::ImageBase< VImageDimension >:

Collaboration diagram for itk::ImageBase< VImageDimension >:

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.

ImageBase manages the geometry of an image. The geometry of an image is defined by its position, orientation, spacing, and extent.

The position and orientation of an image is defined by its "Origin" and its "Directions". The "Origin" is the physical position of the pixel whose "Index" is all zeros. The "Direction" of an image is a matrix whose columns indicate the direction in physical space that each dimension of the image traverses. The first column defines the direction that the fastest moving index in the image traverses in physical space while the last column defines the direction that the slowest moving index in the image traverses in physical space.

The extent of an image is defined by the pixel spacing and a set of regions. The "Spacing" is the size of a pixel in physical space along each dimension. Regions describe a portion of an image grid via a starting index for the image array and a size (or number of pixels) in each dimension. 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]

ImageBase provides all the methods for converting between the physical space and index coordinate frames. TransformIndexToPhysicalPoint() converts an Index in the pixel array into its coordinates in physical space. TransformPhysicalPointToIndex() converts a position in physical space into an Index into the pixel array (using rounding). Subpixel locations are supported by methods that convert to and from ContinuousIndex types.

ImageBase also provides helper routines for the ImageIterators which convert an Index to an offset in memory from the first pixel address as well as covert an offset in memory from the first pixel address to an Index.

Definition at line 105 of file itkImageBase.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >

using	ImageDimensionType = unsigned int

using	IndexType = Index< VImageDimension >

using	IndexValueType = typename IndexType::IndexValueType

using	OffsetType = Offset< VImageDimension >

using	OffsetValueType = typename OffsetType::OffsetValueType

using	Pointer = SmartPointer< Self >

using	PointType = Point< PointValueType, VImageDimension >

using	PointValueType = SpacePrecisionType

using	RegionType = ImageRegion< VImageDimension >

using	Self = ImageBase

using	SizeType = Size< VImageDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SpacingType = Vector< SpacingValueType, VImageDimension >

using	SpacingValueType = SpacePrecisionType

using	Superclass = DataObject

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual void	Allocate (bool initialize=false)

OffsetValueType	ComputeOffset (const IndexType &ind) const

void	CopyInformation (const DataObject *data) override

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const RegionType &	GetBufferedRegion () const

virtual const DirectionType &	GetDirection () const

virtual const DirectionType &	GetInverseDirection () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const char *	GetNameOfClass () const

virtual const PointType &	GetOrigin () const

virtual const RegionType &	GetRequestedRegion () const

virtual const SpacingType &	GetSpacing () const

virtual void	Graft (const Self *data)

void	Initialize () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

virtual void	SetDirection (const DirectionType &direction)

virtual void	SetLargestPossibleRegion (const RegionType &region)

virtual void	SetRegions (const SizeType &size)

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegion (const DataObject *data) override

void	SetRequestedRegionToLargestPossibleRegion () override

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

template<typename TCoordRep >
void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

void	UpdateOutputData () override

void	UpdateOutputInformation () override

bool	VerifyRequestedRegion () override


virtual void	SetOrigin (PointType _arg)

virtual void	SetOrigin (const double origin[VImageDimension])

virtual void	SetOrigin (const float origin[VImageDimension])


virtual void	SetRegions (const RegionType &region)


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<typename TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const


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


virtual unsigned int	GetNumberOfComponentsPerPixel () const

virtual void	SetNumberOfComponentsPerPixel (unsigned int)

Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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 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 constexpr ImageDimensionType	ImageDimension = VImageDimension

Protected Member Functions
virtual void	ComputeIndexToPhysicalPointMatrices ()

void	ComputeOffsetTable ()

void	Graft (const DataObject *data) override

	ImageBase ()

virtual void	InitializeBufferedRegion ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageBase () override=default


OffsetValueType	FastComputeOffset (const IndexType &ind) const


IndexType	FastComputeIndex (OffsetValueType offset) const

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
DirectionType	m_Direction

DirectionType	m_IndexToPhysicalPoint

DirectionType	m_InverseDirection

PointType	m_Origin

DirectionType	m_PhysicalPointToIndex

SpacingType	m_Spacing

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Private Member Functions
void	InternalSetSpacing (const SpacingValueType spacing[VImageDimension])

template<typename TSpacingValue >
void	InternalSetSpacing (const TSpacingValue spacing[VImageDimension])

Private Attributes
RegionType	m_BufferedRegion

RegionType	m_LargestPossibleRegion

OffsetValueType	m_OffsetTable [VImageDimension+1]

RegionType	m_RequestedRegion

Member Typedef Documentation

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::ConstPointer = SmartPointer< const Self >

Definition at line 114 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >

Direction type alias support. The Direction is a matix of direction cosines that specify the direction in physical space between samples along each dimension.

Definition at line 162 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::ImageDimensionType = unsigned int

Type of image dimension

Definition at line 123 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::IndexType = Index< VImageDimension >

Index type alias support. An index is used to access pixel values.

Definition at line 132 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::IndexValueType = typename IndexType::IndexValueType

Definition at line 133 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::OffsetType = Offset< VImageDimension >

Offset type alias support. An offset represent relative position between indices.

Definition at line 137 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 138 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::Pointer = SmartPointer< Self >

Definition at line 113 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::PointType = Point< PointValueType, VImageDimension >

Definition at line 157 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::PointValueType = SpacePrecisionType

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

Definition at line 156 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::RegionType = ImageRegion< VImageDimension >

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

Definition at line 145 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::Self = ImageBase

Standard type alias.

Definition at line 111 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::SizeType = Size< VImageDimension >

Size type alias support. A size is used to define region bounds.

Definition at line 141 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::SizeValueType = typename SizeType::SizeValueType

Definition at line 142 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::SpacingType = Vector< SpacingValueType, VImageDimension >

Definition at line 152 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::SpacingValueType = SpacePrecisionType

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

Definition at line 151 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

using itk::ImageBase< VImageDimension >::Superclass = DataObject

Definition at line 112 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 ( )

overrideprotecteddefault

Member Function Documentation

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::Allocate ( bool initialize = false )

virtual

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

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

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()).

Definition at line 365 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::ComputeIndexToPhysicalPointMatrices ( )

protectedvirtual

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 >, itk::RLEImage< TPixel, VImageDimension, CounterType >, itk::Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >, and itk::Image< TNode *, VImageDimension >.

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::ComputeIndexToPhysicalPointMatrices().

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 330 of file itkImageBase.h.

Referenced by itk::ScanlineFilterCommon< TInputImage, TOutputImage >::SetupLineOffsets().

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>

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

overridevirtual

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.

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

template<unsigned int VImageDimension = 2>

virtual::itk::LightObject::Pointer itk::ImageBase< VImageDimension >::CreateAnother ( ) 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::LightObject.

template<unsigned int VImageDimension = 2>

IndexType itk::ImageBase< VImageDimension >::FastComputeIndex ( OffsetValueType offset ) const

inlineprotected

Directly computes 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()).

Warning: unlike ComputeOffset(), this version does not incur a virtual call. It's meant to be used only for itk::Image<>, itk::VectorImage<> and itk::SpecialCoordinatesImage<>.

Definition at line 726 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

OffsetValueType itk::ImageBase< VImageDimension >::FastComputeOffset ( const IndexType & ind ) const

inlineprotected

Directly computes 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.

Warning: unlike ComputeOffset(), this version does not incur a virtual call. It's meant to be used only for itk::Image<>, itk::VectorImage<> and itk::SpecialCoordinatesImage<>.

Definition at line 704 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetBufferedRegion ( ) const

inlinevirtual

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 263 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

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.

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

template<unsigned int VImageDimension = 2>

static unsigned int itk::ImageBase< VImageDimension >::GetImageDimension ( )

inlinestatic

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

Definition at line 168 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

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

inlinevirtual

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 true conditions.

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

Definition at line 252 of file itkImageBase.h.

Referenced by itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask().

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 in the ImageBase implementation, this always returns 1. Image returns the

returned from NumericTraits for the pixel type, and VectorImage

returns the vector length set by the user.

Reimplemented in itk::VectorImage< TPixelType, VImageDimension >, itk::VectorImage< TPixelType, Dimension >, itk::Image< TPixel, VImageDimension >, itk::Image< SymmetricSecondRankTensor< TOutputValueType, TTransform::InputSpaceDimension >, TTransform::InputSpaceDimension >, itk::Image< TNode *, VImageDimension >, and itk::RLEImage< TPixel, VImageDimension, CounterType >.

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

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 321 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

virtual

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a Point<double, VImageDimension>. For ImageBase and Image, the default origin is 0.

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetRequestedRegion ( ) const

inlinevirtual

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 288 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

virtual

Get the spacing (size of a pixel) `of the image. The spacing is the geometric distance between image samples along each dimension. The value returned is a Vector<double, VImageDimension>. For ImageBase and Image, the default data spacing is unity.

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::Graft ( const Self * 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 >::Graft ( const DataObject * )

overrideprotectedvirtual

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>

void itk::ImageBase< VImageDimension >::Initialize ( )

overridevirtual

Restore object to initialized state.

Reimplemented from itk::DataObject.

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::Initialize().

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::InitializeBufferedRegion ( )

protectedvirtual

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>

void itk::ImageBase< VImageDimension >::InternalSetSpacing ( const SpacingValueType spacing[VImageDimension] )

inlineprivate

Definition at line 741 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename TSpacingValue >

void itk::ImageBase< VImageDimension >::InternalSetSpacing ( const TSpacingValue spacing[VImageDimension] )

inlineprivate

Definition at line 748 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

static

Method for creation through the object factory.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

bool itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

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

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::SetBufferedRegion().

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.

Each column 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, an 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 columns of the Direction matrix are expected to form an orthogonal right handed coordinate syste. But this is not checked nor enforced in itk::ImageBase.

For details, please see:

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

See Also: GetDirection()

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

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 true conditions.

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

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::SetLargestPossibleRegion().

template<unsigned int VImageDimension = 2>

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

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 in the ImageBase implementation, this always returns 1. Image returns the

returned from NumericTraits for the pixel type, and VectorImage

returns the vector length set by the user.

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

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

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 (pixel [0,0]). It is stored internally as SpacePrecisionType but may be set from float or double.

See Also: GetOrigin()

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

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 (pixel [0,0]). It is stored internally as SpacePrecisionType but may be set from float or double.

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

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 in itk::SpecialCoordinatesImage< TPixel, VImageDimension >, and itk::SpecialCoordinatesImage< TPixel, 3 >.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRegions ( const RegionType & region )

inlinevirtual

Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called.

Definition at line 294 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRegions ( const SizeType & size )

inlinevirtual

Definition at line 302 of file itkImageBase.h.

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

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::SetRequestedRegion().

template<unsigned int VImageDimension = 2>

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

overridevirtual

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>

void itk::ImageBase< VImageDimension >::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

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 along each dimension. 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()

Referenced by itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyInformation().

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<typename TCoordRep , typename TIndexRep >

void itk::ImageBase< VImageDimension >::TransformContinuousIndexToPhysicalPoint	(	const ContinuousIndex< TIndexRep, VImageDimension > &	index,
		Point< TCoordRep, VImageDimension > &	point
	)		const

inline

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

See Also: Transform

Definition at line 462 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename 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 information comes from) from a discrete index (in the index space)

See Also: Transform

Definition at line 484 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename TCoordRep >

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

inline

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.

The inputGradient and the outputGradient must not refer to the same data.

See Also: Image

Definition at line 514 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename TCoordRep , typename TIndexRep >

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToContinuousIndex	(	const Point< TCoordRep, VImageDimension > &	point,
		ContinuousIndex< TIndexRep, 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 435 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename 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 411 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<typename 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.

The inputGradient and the outputGradient must not refer to the same data.

Definition at line 547 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::UpdateOutputData ( )

overridevirtual

UpdateOutputData() is part of the pipeline infrastructure to communicate between ProcessObjects and DataObjects. The method of the superclass is overriden 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>

void itk::ImageBase< VImageDimension >::UpdateOutputInformation ( )

overridevirtual

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>

bool itk::ImageBase< VImageDimension >::VerifyRequestedRegion ( )

overridevirtual

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>

constexpr ImageDimensionType 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 129 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_BufferedRegion

private

Definition at line 760 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_Direction

protected

Definition at line 680 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 685 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_InverseDirection

protected

Definition at line 681 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_LargestPossibleRegion

private

Definition at line 758 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

private

Definition at line 756 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

PointType itk::ImageBase< VImageDimension >::m_Origin

protected

Definition at line 679 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex

protected

Definition at line 686 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

RegionType itk::ImageBase< VImageDimension >::m_RequestedRegion

private

Definition at line 759 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

SpacingType itk::ImageBase< VImageDimension >::m_Spacing

protected

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

Definition at line 678 of file itkImageBase.h.

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

itkImageBase.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

returned from NumericTraits for the pixel type, and VectorImage

returned from NumericTraits for the pixel type, and VectorImage

Member Data Documentation

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