itk::ImageFunction< TInputImage, TOutput, TCoordRep > Class Template Reference
[Image Functions]

Evaluates a function of an image at specified position. More...

#include <itkImageFunction.h>

Inheritance diagram for itk::ImageFunction< TInputImage, TOutput, TCoordRep >:

Collaboration diagram for itk::ImageFunction< TInputImage, TOutput, TCoordRep >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer

typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension)> ContinuousIndexType

typedef TCoordRep CoordRepType

typedef InputImageType::IndexType IndexType

typedef
InputImageType::ConstPointer InputImageConstPointer

typedef TInputImage InputImageType

typedef InputImageType::PixelType InputPixelType

typedef Point< TCoordRep,::itk::GetImageDimension
< TInputImage >
::ImageDimension > InputType

typedef TOutput OutputType

typedef SmartPointer< Self > Pointer

typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension)> PointType

typedef ImageFunction Self

typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension)>
, TOutput > Superclass

Public Member Functions

void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

virtual TOutput Evaluate (const PointType &point) const =0

virtual TOutput EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0

virtual TOutput EvaluateAtIndex (const IndexType &index) const =0

Command * GetCommand (unsigned long tag)

bool GetDebug () const

virtual const ContinuousIndexType & GetEndContinuousIndex ()

virtual const IndexType & GetEndIndex ()

const InputImageType * GetInputImage () const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

virtual const char * GetNameOfClass () const

virtual int GetReferenceCount () const

virtual const ContinuousIndexType & GetStartContinuousIndex ()

virtual const IndexType & GetStartIndex ()

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)

virtual void Modified () const

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

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

void SetDebug (bool debugFlag) const

virtual void SetInputImage (const InputImageType *ptr)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

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

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

void ConvertPointToContinousIndex (const PointType &point, ContinuousIndexType &cindex) const

void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

virtual bool IsInsideBuffer (const PointType &point) const

virtual bool IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool IsInsideBuffer (const IndexType &index) const

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

ImageFunction ()

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

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

~ImageFunction ()

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

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

Protected Attributes

ContinuousIndexType m_EndContinuousIndex

IndexType m_EndIndex

InputImageConstPointer m_Image

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

ContinuousIndexType m_StartContinuousIndex

IndexType m_StartIndex

Detailed Description

template<class TInputImage, class TOutput, class TCoordRep = float>
class itk::ImageFunction< TInputImage, TOutput, TCoordRep >

Evaluates a function of an image at specified position.

ImageFunction is a baseclass for all objects that evaluates a function of an image at index, continuous index or point. This class is templated over the input image type, the type of the function output and the coordinate representation type (e.g. float or double).

The input image is set via method SetInputImage(). Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluates the function at an geometric point, image index and continuous image index.

Warning:: Image BufferedRegion information is cached during in SetInputImage( image ). If the image BufferedRegion has changed one must call SetInputImage( image ) again to update the cache to the current values.

See also:

Point

Index

ContinuousIndex

Definition at line 60 of file itkImageFunction.h.

Member Typedef Documentation

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef SmartPointer<const Self> itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConstPointer

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

Definition at line 76 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef ContinuousIndex<TCoordRep,itkGetStaticConstMacro(ImageDimension)> itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ContinuousIndexType

ContinuousIndex Type.

Definition at line 101 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef TCoordRep itk::ImageFunction< TInputImage, TOutput, TCoordRep >::CoordRepType

CoordRepType typedef support.

Reimplemented in itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 94 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef InputImageType::IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IndexType

Index Type.

Definition at line 97 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef InputImageType::ConstPointer itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageConstPointer

InputImagePointer typedef support

Definition at line 88 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef TInputImage itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 79 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef InputImageType::PixelType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputPixelType

InputPixel typedef support

Definition at line 85 of file itkImageFunction.h.

typedef Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension > itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension > , TOutput >::InputType [inherited]

Input type

Definition at line 54 of file itkFunctionBase.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::OutputType

OutputType typedef support.

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

Definition at line 91 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef SmartPointer<Self> itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Pointer

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

Definition at line 75 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef Point<TCoordRep,itkGetStaticConstMacro(ImageDimension)> itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PointType

Point Type.

Definition at line 104 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef ImageFunction itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Self

Standard class typedefs.

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

Definition at line 71 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

typedef FunctionBase< Point<TCoordRep, itkGetStaticConstMacro(ImageDimension)>, TOutput > itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Superclass

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

Definition at line 74 of file itkImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutput, class TCoordRep = float>

itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ImageFunction ( ) [protected]

template<class TInputImage, class TOutput, class TCoordRep = float>

itk::ImageFunction< TInputImage, TOutput, TCoordRep >::~ImageFunction ( ) [inline, protected]

Definition at line 232 of file itkImageFunction.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[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

static void itk::LightObject::BreakOnError ( ) [static, inherited]

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

template<class TInputImage, class TOutput, class TCoordRep = float>

void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertContinuousIndexToNearestIndex	(	const ContinuousIndexType &	cindex,
		IndexType &	index
	)			const `[inline]`

Convert continuous index to nearest index.

Definition at line 218 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertPointToContinousIndex	(	const PointType &	point,
		ContinuousIndexType &	cindex
	)			const `[inline]`

Convert point to continuous index

Definition at line 199 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertPointToContinuousIndex	(	const PointType &	point,
		ContinuousIndexType &	cindex
	)			const `[inline]`

Convert point to continuous index

Definition at line 211 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertPointToNearestIndex	(	const PointType &	point,
		IndexType &	index
	)			const `[inline]`

Convert point to nearest index.

Definition at line 189 of file itkImageFunction.h.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

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.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Evaluate ( const PointType & point ) const [pure virtual]

Evaluate the function at specified Point position. Subclasses must provide this method.

Implements itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const [pure virtual]

Evaluate the function at specified ContinuousIndex position. Subclasses must provide this method.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::EvaluateAtIndex ( const IndexType & index ) const [pure virtual]

Evaluate the function at specified Index position. Subclasses must provide this method.

Implemented in itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::InterpolateImageFunction< TImageType,TCoordRep >, itk::InterpolateImageFunction< TImageType, TCoordRep >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

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.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual const ContinuousIndexType& itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetEndContinuousIndex ( ) [virtual]

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual const IndexType& itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetEndIndex ( ) [virtual]

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

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

template<class TInputImage, class TOutput, class TCoordRep = float>

const InputImageType* itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetInputImage ( ) const [inline]

Get the input image.

Definition at line 113 of file itkImageFunction.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual const char* itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::FunctionBase< Point< TCoordRep,::itk::GetImageDimension< TInputImage >::ImageDimension >, TOutput >.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual const ContinuousIndexType& itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetStartContinuousIndex ( ) [virtual]

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual const IndexType& itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetStartIndex ( ) [virtual]

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

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

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer ( const PointType & point ) const [inline, virtual]

Check if a point is inside the image buffer.

Warning:: For efficiency, no validity checking of the input image pointer is done.

Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 180 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer ( const ContinuousIndexType & index ) const [inline, virtual]

Check if a continuous index is inside the image buffer.

Warning:: For efficiency, no validity checking of the input image is done.

Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 156 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer ( const IndexType & index ) const [inline, virtual]

Check if an index is inside the image buffer. If ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is on, we take into account the fact that each voxel has its center at the integer coordinate and extends half way to the next integer coordinate.

Warning:: For efficiency, no validity checking of the input image is done.

Definition at line 136 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

itk::ImageFunction< TInputImage, TOutput, TCoordRep >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)

Dimension underlying input image.

Reimplemented in itk::CentralDifferenceImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >, and itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

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

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Object::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TInputImage, class TOutput, class TCoordRep = float>

void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::Object::Register ( ) const [virtual, inherited]

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

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

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

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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

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

template<class TInputImage, class TOutput, class TCoordRep = float>

virtual void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::SetInputImage ( const InputImageType * ptr ) [virtual]

Set the input image.

Warning:: this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values.

Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

template<class TInputImage, class TOutput, class TCoordRep = float>

ContinuousIndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_EndContinuousIndex [protected]

Definition at line 242 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_EndIndex [protected]

Definition at line 240 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

InputImageConstPointer itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_Image [protected]

Const pointer to the input image.

Definition at line 236 of file itkImageFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

ContinuousIndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_StartContinuousIndex [protected]

Definition at line 241 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float>

IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_StartIndex [protected]

Cache some values for testing if indices are inside buffered region.

Definition at line 239 of file itkImageFunction.h.

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

itkImageFunction.h


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < TCoordRep, itkGetStaticConstMacro(ImageDimension)>	ContinuousIndexType
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef Point< TCoordRep,::itk::GetImageDimension < TInputImage > ::ImageDimension >	InputType
typedef TOutput	OutputType
typedef SmartPointer< Self >	Pointer
typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)>	PointType
typedef ImageFunction	Self
typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension)> , TOutput >	Superclass
Public Member Functions
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual TOutput	Evaluate (const PointType &point) const =0
virtual TOutput	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
virtual TOutput	EvaluateAtIndex (const IndexType &index) const =0
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const ContinuousIndexType &	GetEndContinuousIndex ()
virtual const IndexType &	GetEndIndex ()
const InputImageType *	GetInputImage () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual const ContinuousIndexType &	GetStartContinuousIndex ()
virtual const IndexType &	GetStartIndex ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetInputImage (const InputImageType *ptr)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

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

void	ConvertPointToContinousIndex (const PointType &point, ContinuousIndexType &cindex) const

void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

virtual bool	IsInsideBuffer (const PointType &point) const

virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool	IsInsideBuffer (const IndexType &index) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	ImageFunction ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~ImageFunction ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
ContinuousIndexType	m_EndContinuousIndex
IndexType	m_EndIndex
InputImageConstPointer	m_Image
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
ContinuousIndexType	m_StartContinuousIndex
IndexType	m_StartIndex

itk::ImageFunction< TInputImage, TOutput, TCoordRep > Class Template Reference [Image Functions]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class TInputImage, class TOutput, class TCoordRep = float> class itk::ImageFunction< TInputImage, TOutput, TCoordRep >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ImageFunction< TInputImage, TOutput, TCoordRep > Class Template Reference
[Image Functions]

template<class TInputImage, class TOutput, class TCoordRep = float>
class itk::ImageFunction< TInputImage, TOutput, TCoordRep >