Templated n-dimensional image class. More...

#include <itkImage.h>

Inheritance diagram for itk::Image< TPixel, VImageDimension >:

Collaboration diagram for itk::Image< TPixel, VImageDimension >:

Public Types
typedef DefaultPixelAccessorFunctor < Self >	AccessorFunctorType

typedef DefaultPixelAccessor < PixelType >	AccessorType

typedef SmartPointer< const Self >	ConstPointer

typedef WeakPointer< const Self >	ConstWeakPointer

typedef Superclass::DirectionType	DirectionType

typedef Superclass::IndexType	IndexType

typedef Superclass::IndexValueType	IndexValueType

typedef TPixel	InternalPixelType

typedef PixelType	IOPixelType

typedef NeighborhoodAccessorFunctor < Self >	NeighborhoodAccessorFunctorType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OffsetValueType	OffsetValueType

typedef ImportImageContainer < unsigned long, PixelType >	PixelContainer

typedef PixelContainer::ConstPointer	PixelContainerConstPointer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef TPixel	PixelType

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef double	PointValueType

typedef Superclass::RegionType	RegionType

typedef Image	Self

typedef Superclass::SizeType	SizeType

typedef Superclass::SizeValueType	SizeValueType

typedef Superclass::SpacingType	SpacingType

typedef double	SpacingValueType

typedef ImageBase < VImageDimension >	Superclass

typedef TPixel	ValueType

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

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

void	Allocate ()

IndexType	ComputeIndex (OffsetValueType offset) const

OffsetValueType	ComputeOffset (const IndexType &ind) const

virtual void	CopyInformation (const DataObject *data)

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

void	DataHasBeenGenerated ()

virtual void	DebugOff () const

virtual void	DebugOn () const

virtual void	Delete ()

void	DisconnectPipeline ()

void	FillBuffer (const TPixel &value)

virtual const RegionType &	GetBufferedRegion () const

TPixel *	GetBufferPointer ()

const TPixel *	GetBufferPointer () const

Command *	GetCommand (unsigned long tag)

bool	GetDataReleased () const

bool	GetDebug () const

virtual const DirectionType &	GetDirection ()

virtual const RegionType &	GetLargestPossibleRegion () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual unsigned long	GetMTime () const

virtual const char *	GetNameOfClass () const

NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()

const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const

virtual unsigned int	GetNumberOfComponentsPerPixel () const

const OffsetValueType *	GetOffsetTable () const

virtual const PointType &	GetOrigin ()

virtual const unsigned long &	GetPipelineMTime ()

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

PixelContainer *	GetPixelContainer ()

const PixelContainer *	GetPixelContainer () const

virtual int	GetReferenceCount () const

virtual const bool &	GetReleaseDataFlag ()

virtual const RegionType &	GetRequestedRegion () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

unsigned int	GetSourceOutputIndex () const

virtual const SpacingType &	GetSpacing ()

virtual unsigned long	GetUpdateMTime () const

virtual void	Graft (const DataObject *data)

bool	HasObserver (const EventObject &event) const

virtual void	Initialize ()

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

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

void	Print (std::ostream &os, Indent indent=0) const

virtual void	PropagateRequestedRegion ()

virtual void	Register () const

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

virtual void	SetBufferedRegion (const RegionType &region)

void	SetDebug (bool debugFlag) const

virtual void	SetDirection (const DirectionType direction)

virtual void	SetLargestPossibleRegion (const RegionType &region)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetNumberOfComponentsPerPixel (unsigned int)

virtual void	SetOrigin (PointType _arg)

virtual void	SetOrigin (const double origin[VImageDimension])

virtual void	SetOrigin (const float origin[VImageDimension])

void	SetPipelineMTime (unsigned long time)

void	SetPixel (const IndexType &index, const TPixel &value)
	Set a pixel value. More...

void	SetPixelContainer (PixelContainer *container)

virtual void	SetReferenceCount (int)

void	SetRegions (RegionType region)

void	SetRegions (SizeType size)

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegion (DataObject *data)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

virtual void	SetSpacing (const SpacingType &spacing)

virtual void	SetSpacing (const double spacing[VImageDimension])

virtual void	SetSpacing (const float spacing[VImageDimension])

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

template<class TCoordRep >
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

template<class TCoordRep >
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
	Get the continuous index from a physical point. More...

template<class TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const

virtual void	UnRegister () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

virtual bool	VerifyRequestedRegion ()

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalReleaseDataFlag ()

static bool	GetGlobalWarningDisplay ()

static unsigned int	GetImageDimension ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalReleaseDataFlag (bool val)

static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	Image ()

virtual	~Image ()

virtual void	ComputeIndexToPhysicalPointMatrices ()

void	ComputeOffsetTable ()

virtual void	InitializeBufferedRegion (void)

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

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

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

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

virtual void	PropagateResetPipeline ()

Protected Attributes
DirectionType	m_Direction

DirectionType	m_IndexToPhysicalPoint

PointType	m_Origin

DirectionType	m_PhysicalPointToIndex

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

SpacingType	m_Spacing

Private Member Functions
	Image (const Self &)

void	operator= (const Self &)

Private Attributes
PixelContainerPointer	m_Buffer

Detailed Description

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

Templated n-dimensional image class.

Images 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 modeled as arrays, defined by a start index and a size.

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

Definition at line 81 of file itkImage.h.

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2>

typedef DefaultPixelAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::AccessorFunctorType

Definition at line 115 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef DefaultPixelAccessor< PixelType > itk::Image< TPixel, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 114 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef SmartPointer<const Self> itk::Image< TPixel, VImageDimension >::ConstPointer

Definition at line 88 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef WeakPointer<const Self> itk::Image< TPixel, VImageDimension >::ConstWeakPointer

Definition at line 89 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::DirectionType itk::Image< TPixel, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.

Definition at line 142 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::IndexType itk::Image< TPixel, VImageDimension >::IndexType

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

Definition at line 131 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::IndexValueType itk::Image< TPixel, VImageDimension >::IndexValueType

Definition at line 132 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::Image< 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 108 of file itkImage.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelType itk::Image< TPixel, VImageDimension >::IOPixelType

Definition at line 110 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef NeighborhoodAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType

Typedef for the functor used to access a neighborhood of pixel pointers.

Definition at line 119 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetType itk::Image< TPixel, VImageDimension >::OffsetType

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

Definition at line 135 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetValueType itk::Image< TPixel, VImageDimension >::OffsetValueType

Offset typedef (relative position between indices)

Definition at line 160 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef ImportImageContainer<unsigned long, PixelType> itk::Image< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Definition at line 128 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::ConstPointer itk::Image< TPixel, VImageDimension >::PixelContainerConstPointer

Definition at line 157 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::Pointer itk::Image< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Definition at line 156 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::Image< TPixel, VImageDimension >::PixelType

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

Definition at line 95 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef SmartPointer<Self> itk::Image< TPixel, VImageDimension >::Pointer

Definition at line 87 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::PointType itk::Image< TPixel, VImageDimension >::PointType

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

Definition at line 153 of file itkImage.h.

template<unsigned int VImageDimension = 2>

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

inherited

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

Definition at line 133 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::RegionType itk::Image< TPixel, VImageDimension >::RegionType

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

Definition at line 145 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Image itk::Image< TPixel, VImageDimension >::Self

Standard class typedefs

Definition at line 85 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SizeType itk::Image< TPixel, VImageDimension >::SizeType

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

Definition at line 138 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SizeValueType itk::Image< TPixel, VImageDimension >::SizeValueType

Definition at line 139 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SpacingType itk::Image< TPixel, VImageDimension >::SpacingType

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 149 of file itkImage.h.

template<unsigned int VImageDimension = 2>

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

inherited

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.

Definition at line 128 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef ImageBase<VImageDimension> itk::Image< TPixel, VImageDimension >::Superclass

Definition at line 86 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::Image< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 102 of file itkImage.h.

Constructor & Destructor Documentation

template<class TPixel , unsigned int VImageDimension>

itk::Image< TPixel, VImageDimension >::Image ( )

protected

Definition at line 34 of file itkImage.txx.

template<class TPixel, unsigned int VImageDimension = 2>

virtual itk::Image< TPixel, VImageDimension >::~Image ( )

inlineprotectedvirtual

Reimplemented in otb::Image< TPixel, VImageDimension >, otb::Image< TOutputPixel, 2 >, otb::Image< TInputPixel, 2 >, and otb::Image< TOutputPixelType, 2 >.

Definition at line 287 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

itk::Image< TPixel, VImageDimension >::Image ( const Self & )

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

template<class TPixel , unsigned int VImageDimension>

void itk::Image< TPixel, VImageDimension >::Allocate ( )

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 44 of file itkImage.txx.

Referenced by itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::Initialize().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<unsigned int VImageDimension = 2>

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

inlineinherited

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

template<class TPixel , unsigned int VImageDimension>

void itk::Image< TPixel, 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 from itk::ImageBase< VImageDimension >.

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.

Definition at line 144 of file itkImage.txx.

template<unsigned int VImageDimension = 2>

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

inlineinherited

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

template<unsigned int VImageDimension>

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

protectedinherited

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.

Definition at line 204 of file itkImageBase.txx.

References itk::Size< VDimension >::GetSize().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 307 of file itkImageBase.txx.

References itk::ImageBase< VImageDimension >::GetDirection(), itk::ImageBase< VImageDimension >::GetLargestPossibleRegion(), itk::ImageBase< VImageDimension >::GetNumberOfComponentsPerPixel(), itk::ImageBase< VImageDimension >::GetOrigin(), and itk::ImageBase< VImageDimension >::GetSpacing().

Referenced by itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::GenerateOutputInformation().

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.

void itk::DataObject::DataHasBeenGenerated ( )

inherited

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

Definition at line 428 of file itkDataObject.cxx.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

void itk::DataObject::DisconnectPipeline ( )

inherited

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Definition at line 216 of file itkDataObject.cxx.

template<class TPixel, unsigned int VImageDimension>

void itk::Image< TPixel, VImageDimension >::FillBuffer ( const TPixel & value )

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

Definition at line 77 of file itkImage.txx.

template<unsigned int VImageDimension = 2>

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

inlinevirtualinherited

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

Referenced by itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), and otb::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput().

template<class TPixel, unsigned int VImageDimension = 2>

TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer ( )

inline

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

Definition at line 239 of file itkImage.h.

Referenced by itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::BuildFromImage().

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer ( ) const

inline

Definition at line 241 of file itkImage.h.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::DataObject::GetDataReleased ( ) const

inlineinherited

Get the flag indicating the data has been released.

Definition at line 332 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<unsigned int VImageDimension = 2>

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

virtualinherited

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::ImageBase< VImageDimension >::CopyInformation(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), otb::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), and itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage().

bool itk::DataObject::GetGlobalReleaseDataFlag ( )

staticinherited

Definition at line 189 of file itkDataObject.cxx.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<unsigned int VImageDimension = 2>

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

inlinestaticinherited

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

Definition at line 145 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

inlinevirtualinherited

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

Referenced by itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::BuildFromImage(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::CollapsePhiLattice(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ComputeJacobian(), itk::ImageBase< VImageDimension >::CopyInformation(), otb::ViewerViewGUI::DisplayPreviewWidget(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ExpandVectorField(), itk::MRIBiasFieldCorrectionFilter< TInputImage, TOutputImage, TMaskImage >::ExpImage(), otb::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), itk::MetaImageConverter< NDimensions, PixelType >::ImageSpatialObjectToMetaImage(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::SetDeformationField(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), otb::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), and itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

template<class TPixel, unsigned int VImageDimension = 2>

virtual const char* itk::Image< TPixel, VImageDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< TImageDimension >, TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, otb::Image< TPixel, VImageDimension >, otb::Image< TOutputPixel, 2 >, otb::Image< TInputPixel, 2 >, otb::Image< TOutputPixelType, 2 >, itk::OrientedImage< TPixel, VImageDimension >, and itk::BloxBoundaryPointImage< TImageDimension >.

template<class TPixel, unsigned int VImageDimension = 2>

NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( )

inline

Return the NeighborhoodAccessor functor

Definition at line 277 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const

inline

Return the NeighborhoodAccessor functor

Definition at line 281 of file itkImage.h.

template<unsigned int VImageDimension>

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

virtualinherited

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< TOutputPixelType, VImageDimension >, itk::VectorImage< TNeuron::ComponentType, VImageDimension >, itk::VectorImage< TInputPixelType, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

Definition at line 521 of file itkImageBase.txx.

Referenced by itk::ImageBase< VImageDimension >::CopyInformation().

template<unsigned int VImageDimension = 2>

const OffsetValueType* itk::ImageBase< VImageDimension >::GetOffsetTable ( void ) const

inlineinherited

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

template<unsigned int VImageDimension = 2>

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

virtualinherited

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.

Referenced by itk::ImageBase< VImageDimension >::CopyInformation(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), otb::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), and itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage().

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( )

virtualinherited

Referenced by itk::ProcessObject::UpdateOutputInformation().

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::Image< 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 207 of file itkImage.h.

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::CollapsePhiLattice(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ComputeJacobian(), itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetPriorityImage(), otb::Multi3DMapToDEMFilter< T3DImage, TMaskImage, TOutputDEMImage >::ThreadedGenerateData(), and itk::DanielssonDistanceMapImageFilter< TInputImage, TOutputImage >::UpdateLocalDistance().

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::Image< 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 217 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor ( void )

inline

Return the Pixel Accessor object

Definition at line 269 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor ( void ) const

inline

Return the Pixel Accesor object

Definition at line 273 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer ( )

inline

Return a pointer to the container.

Definition at line 245 of file itkImage.h.

Referenced by itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), and otb::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput().

template<class TPixel, unsigned int VImageDimension = 2>

const PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer ( ) const

inline

Definition at line 248 of file itkImage.h.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( )

virtualinherited

template<unsigned int VImageDimension = 2>

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

inlinevirtualinherited

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

Referenced by itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::ComputeCurvatureTarget(), otb::PipelineMemoryPrintCalculator::EvaluateDataObjectPrint(), itk::HistogramToImageFilter< THistogram, TFunction >::GenerateData(), otb::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateInputRequestedRegion(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateInputRequestedRegion(), otb::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), itk::watershed::Relabeler< TScalarType, TImageDimension >::GraftNthOutput(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::Initialize(), itk::MRIBiasFieldCorrectionFilter< TInputImage, TOutputImage, TMaskImage >::Log1PImage(), otb::CumulantsForEdgeworth< TInput >::MakeSumAndMoments(), and itk::ImageBase< VImageDimension >::SetRequestedRegion().

SmartPointerForwardReference< ProcessObject > itk::DataObject::GetSource ( void ) const

inherited

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

Definition at line 288 of file itkDataObject.cxx.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const

inherited

Which of the source's outputs corresponds to this data object?

Definition at line 296 of file itkDataObject.cxx.

Referenced by itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion().

template<unsigned int VImageDimension = 2>

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

virtualinherited

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.

unsigned long itk::DataObject::GetUpdateMTime ( ) const

virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

static void itk::DataObject::GlobalReleaseDataFlagOff ( )

inlinestaticinherited

Definition at line 318 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( )

inlinestaticinherited

Definition at line 316 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TPixel , unsigned int VImageDimension>

void itk::Image< TPixel, 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. The implementation here refers to the superclass' implementation and then copies over the pixel container.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 104 of file itkImage.txx.

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

template<class TPixel , unsigned int VImageDimension>

void itk::Image< TPixel, VImageDimension >::Initialize ( void )

virtual

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

Reimplemented from itk::DataObject.

Reimplemented in itk::SparseImage< TNode, VImageDimension >.

Definition at line 57 of file itkImage.txx.

template<unsigned int VImageDimension>

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

protectedvirtualinherited

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

Definition at line 461 of file itkImageBase.txx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TPixel, unsigned int VImageDimension = 2>

static Pointer itk::Image< TPixel, VImageDimension >::New ( )

static

Method for creation through the object factory.

Referenced by itk::RegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::AllocateListImage(), and itk::fem::Solver::InitializeInterpolationGrid().

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< TPixel, VImageDimension >::operator= ( const Self & )

private

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::Image< 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 227 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::Image< 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 234 of file itkImage.h.

virtual void itk::DataObject::PrepareForNewData ( )

inlinevirtualinherited

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 385 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

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

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TPixel , unsigned int VImageDimension>

void itk::Image< 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 185 of file itkImage.txx.

References itk::Indent::GetNextIndent().

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

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::DataObject::PropagateRequestedRegion ( void )

virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Definition at line 379 of file itkDataObject.cxx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::DataObject::PropagateResetPipeline ( )

protectedvirtualinherited

Propagate a call to ResetPipeline(). Called only from ProcessObject.

Definition at line 367 of file itkDataObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::DataObject::ReleaseData ( )

inherited

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

Definition at line 197 of file itkDataObject.cxx.

virtual void itk::DataObject::ReleaseDataFlagOff ( )

virtualinherited

virtual void itk::DataObject::ReleaseDataFlagOn ( )

virtualinherited

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 386 of file itkImageBase.txx.

References itk::Index< VIndexDimension >::GetIndex(), and itk::Size< VDimension >::GetSize().

void itk::DataObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 360 of file itkDataObject.cxx.

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 446 of file itkImageBase.txx.

Referenced by itk::ImageSource< TOutputImage >::AllocateOutputs(), and itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::Initialize().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 151 of file itkImageBase.txx.

void itk::DataObject::SetGlobalReleaseDataFlag ( bool val )

staticinherited

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 177 of file itkDataObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 508 of file itkImageBase.txx.

Referenced by otb::ImageSimulationMethod< TInputVectorData, TSpatialisation, TSimulationStep1, TSimulationStep2, TFTM, TOutputImage >::GenerateOutputInformation().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

template<unsigned int VImageDimension>

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

virtualinherited

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, itk::VectorImage< TOutputPixelType, VImageDimension >, itk::VectorImage< TNeuron::ComponentType, VImageDimension >, itk::VectorImage< TInputPixelType, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

Definition at line 533 of file itkImageBase.txx.

template<unsigned int VImageDimension = 2>

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

virtualinherited

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

Referenced by itk::HistogramToImageFilter< THistogram, TFunction >::GenerateOutputInformation(), and otb::ImageSimulationMethod< TInputVectorData, TSpatialisation, TSimulationStep1, TSimulationStep2, TFTM, TOutputImage >::GenerateOutputInformation().

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 128 of file itkImageBase.txx.

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 139 of file itkImageBase.txx.

References itk::Point< TCoordRep, NPointDimension >::CastFrom().

void itk::DataObject::SetPipelineMTime ( unsigned long time )

inlineinherited

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 370 of file itkDataObject.h.

Referenced by itk::ProcessObject::UpdateOutputInformation().

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< 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 197 of file itkImage.h.

Referenced by itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::ComputeGradient(), and otb::Multi3DMapToDEMFilter< T3DImage, TMaskImage, TOutputDEMImage >::ThreadedGenerateData().

template<class TPixel , unsigned int VImageDimension>

void itk::Image< TPixel, VImageDimension >::SetPixelContainer ( PixelContainer * container )

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

Definition at line 91 of file itkImage.txx.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< TPixel, VImageDimension >::SetRegions ( RegionType region )

inline

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

Definition at line 169 of file itkImage.h.

Referenced by itk::HistogramToImageFilter< THistogram, TFunction >::GenerateOutputInformation().

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< TPixel, VImageDimension >::SetRegions ( SizeType size )

inline

Definition at line 176 of file itkImage.h.

void itk::DataObject::SetReleaseDataFlag ( bool flag )

inlineinherited

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 479 of file itkImageBase.txx.

Referenced by itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateInputRequestedRegion(), otb::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateInputRequestedRegion(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GenerateOutputRequestedRegion(), itk::watershed::Relabeler< TScalarType, TImageDimension >::GenerateOutputRequestedRegion(), otb::watershed::Relabeler< TScalarType, TImageDimension >::GenerateOutputRequestedRegion(), itk::watershed::Segmenter< TInputImage >::GenerateOutputRequestedRegion(), and otb::watershed::Segmenter< TInputImage >::GenerateOutputRequestedRegion().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 491 of file itkImageBase.txx.

References itk::ImageBase< VImageDimension >::GetRequestedRegion().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 298 of file itkImageBase.txx.

template<unsigned int VImageDimension>

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

virtualinherited

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

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

Definition at line 89 of file itkImageBase.txx.

Referenced by itk::HistogramToImageFilter< THistogram, TFunction >::GenerateOutputInformation().

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 105 of file itkImageBase.txx.

template<unsigned int VImageDimension>

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

virtualinherited

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

Definition at line 116 of file itkImageBase.txx.

References itk::Vector< T, NVectorDimension >::CastFrom().

bool itk::DataObject::ShouldIReleaseData ( ) const

inherited

Return flag indicating whether data should be released after use by a filter.

Definition at line 206 of file itkDataObject.cxx.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

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

inlineinherited

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

inlineinherited

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

inlineinherited

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 OrientedImage 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 501 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

inlineinherited

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

inlineinherited

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

See Also: Transform

Definition at line 378 of file itkImageBase.h.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::DataObject::Update ( void )

virtualinherited

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

Definition at line 340 of file itkDataObject.cxx.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation(), and otb::WatershedImageFilter< TInputImage >::GetBasicSegmentation().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 264 of file itkImageBase.txx.

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 230 of file itkImageBase.txx.

Referenced by otb::Wrapper::InputImageListParameter::AddImage(), and otb::ImageWidgetBase< TPixel >::SetInput().

template<unsigned int VImageDimension>

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

virtualinherited

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.

Definition at line 413 of file itkImageBase.txx.

References itk::Index< VIndexDimension >::GetIndex(), and itk::Size< VDimension >::GetSize().

Member Data Documentation

template<class TPixel, unsigned int VImageDimension = 2>

const unsigned int itk::Image< 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 125 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

PixelContainerPointer itk::Image< TPixel, VImageDimension >::m_Buffer

private

Memory for the current buffer.

Definition at line 301 of file itkImage.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_Direction

protectedinherited

Definition at line 638 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_IndexToPhysicalPoint

protectedinherited

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

Definition at line 642 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

PointType itk::ImageBase< VImageDimension >::m_Origin

protectedinherited

Definition at line 637 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex

protectedinherited

Definition at line 643 of file itkImageBase.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<unsigned int VImageDimension = 2>

SpacingType itk::ImageBase< VImageDimension >::m_Spacing

protectedinherited

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

Definition at line 636 of file itkImageBase.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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