Implementation of an Mesh as spatial object. More...

#include <itkMeshSpatialObject.h>

Inheritance diagram for itk::MeshSpatialObject< TMesh >:

Collaboration diagram for itk::MeshSpatialObject< TMesh >:

Public Types
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer

typedef AffineGeometryFrame < double, TDimension >	AffineGeometryFrameType

typedef BoundingBoxType::Pointer	BoundingBoxPointer

typedef Superclass::BoundingBoxType	BoundingBoxType

typedef ChildrenListType *	ChildrenListPointer

typedef std::list< Pointer >	ChildrenListType

typedef SmartPointer< const Self >	ConstPointer

typedef CovariantVector < ScalarType, TDimension >	CovariantVectorType

typedef Index< TDimension >	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef Point< ScalarType, TDimension >	InputType

typedef MeshType::Pointer	MeshPointer

typedef TMesh	MeshType

typedef Offset< TDimension >	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef OutputVectorType *	OutputVectorPointer

typedef CovariantVector < double, TDimension >	OutputVectorType

typedef PointContainerType::Pointer	PointContainerPointer

typedef VectorContainer < unsigned long, PointType >	PointContainerType

typedef SmartPointer< Self >	Pointer

typedef PointType *	PointPointer

typedef Superclass::PointType	PointType

typedef PropertyType::Pointer	PropertyPointer

typedef SpatialObjectProperty < float >	PropertyType

typedef ImageRegion< TDimension >	RegionType

typedef double	ScalarType

typedef MeshSpatialObject< TMesh >	Self

typedef Size< TDimension >	SizeType

typedef double *	SpacingType

typedef SpatialObject < itkGetStaticConstMacro(Dimension) >	Superclass

typedef const TransformType *	TransformConstPointer

typedef TransformType::Pointer	TransformPointer

typedef Superclass::TransformType	TransformType

typedef SpatialObjectTreeNode < TDimension >	TreeNodeType

typedef VectorContainer < unsigned long int, PointType >	VectorContainerType

typedef VectorType *	VectorPointer

typedef Vector< ScalarType, TDimension >	VectorType

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

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

void	AddSpatialObject (Self *pointer)

virtual void	Clear (void)

virtual bool	ComputeBoundingBox () const

IndexType	ComputeIndex (OffsetValueType offset) const

bool	ComputeLocalBoundingBox () const

void	ComputeObjectToParentTransform (void)

void	ComputeObjectToWorldTransform (void)

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

virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)

void	DisconnectPipeline ()

bool	Evaluate (const PointType &point) const

virtual const AffineGeometryFrameType *	GetAffineGeometryFrame ()

virtual BoundingBoxType *	GetBoundingBox () const

virtual const unsigned int &	GetBoundingBoxChildrenDepth ()

virtual const std::string &	GetBoundingBoxChildrenName ()

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=NULL) const

Command *	GetCommand (unsigned long tag)

bool	GetDataReleased () const

bool	GetDebug () const

virtual double	GetDefaultInsideValue () const

virtual double	GetDefaultOutsideValue () const

virtual const int &	GetId ()

TransformType *	GetIndexToObjectTransform (void)

const TransformType *	GetIndexToObjectTransform (void) const

virtual TransformType *	GetIndexToWorldTransform ()

virtual const TransformType *	GetIndexToWorldTransform ()

virtual double	GetIsInsidePrecision ()

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth ()

MeshType *	GetMesh (void)

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

unsigned long	GetMTime (void) const

virtual const char *	GetNameOfClass () const

TransformType *	GetNodeToParentNodeTransform (void)

const TransformType *	GetNodeToParentNodeTransform (void) const

unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const

unsigned int	GetObjectDimension (void) const

unsigned long	GetObjectMTime (void) const

TransformType *	GetObjectToNodeTransform (void)

const TransformType *	GetObjectToNodeTransform (void) const

TransformType *	GetObjectToParentTransform (void)

const TransformType *	GetObjectToParentTransform (void) const

virtual TransformType *	GetObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform ()

const OffsetValueType *	GetOffsetTable () const

virtual const Self *	GetParent (void) const

virtual Self *	GetParent (void)

virtual const int &	GetParentId ()

virtual const unsigned long &	GetPipelineMTime ()

const char *	GetPixelType ()

PropertyType *	GetProperty (void)

const PropertyType *	GetProperty (void) const

virtual int	GetReferenceCount () const

virtual const bool &	GetReleaseDataFlag ()

virtual const RegionType &	GetRequestedRegion () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

unsigned int	GetSourceOutputIndex () const

virtual const double *	GetSpacing () const

virtual std::string	GetSpatialObjectTypeAsString () const

unsigned long	GetTransformMTime (void)

virtual TreeNodeType *	GetTreeNode ()

virtual const TreeNodeType *	GetTreeNode ()

virtual const char *	GetTypeName (void) const

virtual unsigned long	GetUpdateMTime () const

unsigned long	GetWorldTransformMTime (void)

virtual void	Graft (const DataObject *)

bool	HasObserver (const EventObject &event) const

virtual bool	HasParent (void) const

virtual void	Initialize ()

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const

virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const

bool	IsInside (const PointType &point, unsigned int depth, char *name) const

virtual bool	IsInside (const PointType &point) const

virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const

virtual void	Modified () const

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)

void	RemoveSpatialObject (Self *object)

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)

virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)

virtual void	SetBoundingBoxChildrenName (std::string _arg)

virtual void	SetBufferedRegion (const RegionType &region)

void	SetChildren (ChildrenListType &children)

void	SetDebug (bool debugFlag) const

virtual void	SetDefaultInsideValue (double _arg)

virtual void	SetDefaultOutsideValue (double _arg)

virtual void	SetId (int _arg)

virtual void	SetIsInsidePrecision (double _arg)

virtual void	SetLargestPossibleRegion (const RegionType &region)

void	SetMesh (MeshType *Mesh)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetNodeToParentNodeTransform (TransformType *transform)

void	SetObjectToParentTransform (TransformType *transform)

void	SetObjectToWorldTransform (TransformType *transform)

void	SetParent (Self *parent)

virtual void	SetParentId (int _arg)

void	SetPipelineMTime (unsigned long time)

void	SetProperty (PropertyType *property)

virtual void	SetReferenceCount (int)

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegion (DataObject *data)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])

virtual void	SetTreeNode (TreeNodeType *_arg)

bool	ShouldIReleaseData () const

virtual void	UnRegister () const

virtual void	Update (void)

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const

virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const

virtual bool	VerifyRequestedRegion ()

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalReleaseDataFlag ()

static bool	GetGlobalWarningDisplay ()

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	Dimension = TMesh::PointDimension

static const unsigned int	MaximumDepth

static const unsigned int	ObjectDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	MeshSpatialObject ()

virtual	~MeshSpatialObject ()

void	ComputeOffsetTable ()

virtual const BoundingBoxType *	GetBounds ()

virtual const unsigned int &	GetDimension ()

virtual const TransformType *	GetInternalInverseTransform ()

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

virtual void	SetDimension (unsigned int _arg)

bool	SetInternalInverseTransformToWorldToIndexTransform () const

virtual void	SetTypeName (std::string _arg)

Protected Attributes
double	m_IsInsidePrecision

MeshPointer	m_Mesh

std::string	m_PixelType

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Detailed Description

template<class TMesh = Mesh<int>>
class itk::MeshSpatialObject< TMesh >

Implementation of an Mesh as spatial object.

This class combines functionnalities from a spatial object, and an itkMesh.

See Also: SpatialObject

Definition at line 38 of file itkMeshSpatialObject.h.

Member Typedef Documentation

typedef AffineGeometryFrameType::Pointer itk::SpatialObject< TDimension >::AffineGeometryFramePointer

inherited

Definition at line 114 of file itkSpatialObject.h.

typedef AffineGeometryFrame<double,TDimension> itk::SpatialObject< TDimension >::AffineGeometryFrameType

inherited

Definition at line 113 of file itkSpatialObject.h.

typedef BoundingBoxType::Pointer itk::SpatialObject< TDimension >::BoundingBoxPointer

inherited

Definition at line 111 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef Superclass::BoundingBoxType itk::MeshSpatialObject< TMesh >::BoundingBoxType

Definition at line 57 of file itkMeshSpatialObject.h.

typedef ChildrenListType* itk::SpatialObject< TDimension >::ChildrenListPointer

inherited

Definition at line 118 of file itkSpatialObject.h.

typedef std::list< Pointer > itk::SpatialObject< TDimension >::ChildrenListType

inherited

Return type for the list of children

Definition at line 117 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef SmartPointer< const Self > itk::MeshSpatialObject< TMesh >::ConstPointer

Definition at line 51 of file itkMeshSpatialObject.h.

typedef CovariantVector<ScalarType, TDimension > itk::SpatialObject< TDimension >::CovariantVectorType

inherited

Definition at line 95 of file itkSpatialObject.h.

typedef Index<TDimension> itk::SpatialObject< TDimension >::IndexType

inherited

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

Definition at line 122 of file itkSpatialObject.h.

typedef IndexType::IndexValueType itk::SpatialObject< TDimension >::IndexValueType

inherited

Definition at line 123 of file itkSpatialObject.h.

typedef Point< ScalarType, TDimension > itk::SpatialObject< TDimension >::InputType

inherited

Definition at line 91 of file itkSpatialObject.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 TMesh = Mesh<int>>

typedef MeshType::Pointer itk::MeshSpatialObject< TMesh >::MeshPointer

Definition at line 54 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef TMesh itk::MeshSpatialObject< TMesh >::MeshType

Definition at line 53 of file itkMeshSpatialObject.h.

typedef Offset<TDimension> itk::SpatialObject< TDimension >::OffsetType

inherited

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

Definition at line 127 of file itkSpatialObject.h.

typedef OffsetType::OffsetValueType itk::SpatialObject< TDimension >::OffsetValueType

inherited

Definition at line 128 of file itkSpatialObject.h.

typedef OutputVectorType* itk::SpatialObject< TDimension >::OutputVectorPointer

inherited

Definition at line 101 of file itkSpatialObject.h.

typedef CovariantVector< double, TDimension > itk::SpatialObject< TDimension >::OutputVectorType

inherited

Definition at line 100 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef PointContainerType::Pointer itk::MeshSpatialObject< TMesh >::PointContainerPointer

Definition at line 60 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef VectorContainer< unsigned long, PointType> itk::MeshSpatialObject< TMesh >::PointContainerType

Definition at line 59 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef SmartPointer< Self > itk::MeshSpatialObject< TMesh >::Pointer

Definition at line 50 of file itkMeshSpatialObject.h.

typedef PointType* itk::SpatialObject< TDimension >::PointPointer

inherited

Definition at line 92 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef Superclass::PointType itk::MeshSpatialObject< TMesh >::PointType

Definition at line 56 of file itkMeshSpatialObject.h.

typedef PropertyType::Pointer itk::SpatialObject< TDimension >::PropertyPointer

inherited

Definition at line 132 of file itkSpatialObject.h.

typedef SpatialObjectProperty< float > itk::SpatialObject< TDimension >::PropertyType

inherited

Definition at line 131 of file itkSpatialObject.h.

typedef ImageRegion<TDimension> itk::SpatialObject< TDimension >::RegionType

inherited

Definition at line 129 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef double itk::MeshSpatialObject< TMesh >::ScalarType

Definition at line 44 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef MeshSpatialObject< TMesh> itk::MeshSpatialObject< TMesh >::Self

Definition at line 45 of file itkMeshSpatialObject.h.

typedef Size<TDimension> itk::SpatialObject< TDimension >::SizeType

inherited

Definition at line 130 of file itkSpatialObject.h.

typedef double* itk::SpatialObject< TDimension >::SpacingType

inherited

Definition at line 98 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef SpatialObject< itkGetStaticConstMacro(Dimension) > itk::MeshSpatialObject< TMesh >::Superclass

Definition at line 49 of file itkMeshSpatialObject.h.

typedef const TransformType* itk::SpatialObject< TDimension >::TransformConstPointer

inherited

Definition at line 105 of file itkSpatialObject.h.

typedef TransformType::Pointer itk::SpatialObject< TDimension >::TransformPointer

inherited

Definition at line 104 of file itkSpatialObject.h.

template<class TMesh = Mesh<int>>

typedef Superclass::TransformType itk::MeshSpatialObject< TMesh >::TransformType

Definition at line 55 of file itkMeshSpatialObject.h.

typedef SpatialObjectTreeNode<TDimension> itk::SpatialObject< TDimension >::TreeNodeType

inherited

Definition at line 134 of file itkSpatialObject.h.

typedef VectorContainer< unsigned long int, PointType > itk::SpatialObject< TDimension >::VectorContainerType

inherited

Definition at line 107 of file itkSpatialObject.h.

typedef VectorType* itk::SpatialObject< TDimension >::VectorPointer

inherited

Definition at line 96 of file itkSpatialObject.h.

typedef Vector< ScalarType, TDimension > itk::SpatialObject< TDimension >::VectorType

inherited

Definition at line 94 of file itkSpatialObject.h.

Constructor & Destructor Documentation

template<class TMesh >

itk::MeshSpatialObject< TMesh >::MeshSpatialObject ( )

protected

Constructor

Definition at line 29 of file itkMeshSpatialObject.txx.

template<class TMesh >

itk::MeshSpatialObject< TMesh >::~MeshSpatialObject ( )

protectedvirtual

Destructor

Definition at line 41 of file itkMeshSpatialObject.txx.

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

void itk::SpatialObject< TDimension >::AddSpatialObject ( Self * pointer )

inherited

Theses functions are just calling the itkSpatialObjectTreeNode functions Add an object to the list of children.

Add a child to the object

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.

virtual void itk::SpatialObject< TDimension >::Clear ( void )

virtualinherited

Clear the spatial object by deleting all lists of children and subchildren

virtual bool itk::SpatialObject< TDimension >::ComputeBoundingBox ( void ) const

virtualinherited

Compute an axis-aligned bounding box for an object and its selected children, down to a specified depth. After computation, the resulting bounding box is stored in this->m_Bounds.

By default, the bounding box children depth is maximum, meaning that the bounding box for the object and all its recursive children is computed. This depth can be set (before calling ComputeBoundingBox) using SetBoundingBoxChildrenDepth().

By calling SetBoundingBoxChildrenName(), it is possible to restrict the bounding box computation to objects of a specified type or family of types. The spatial objects included in the computation are those whose typenames share, as their initial substring, the string specified via SetBoundingBoxChildrenName(). The root spatial object (on which the method is called) is not treated specially. If its typename does not match the bounding box children name, then it is not included in the bounding box computation, but its descendents that match the string are included.

IndexType itk::SpatialObject< TDimension >::ComputeIndex ( OffsetValueType offset ) const

inlineinherited

Compute the index of the pixel at a specified offset from the beginning of the buffered region.

Definition at line 310 of file itkSpatialObject.h.

References itk::ImageRegion< VImageDimension >::GetIndex(), itk::SpatialObject< TDimension >::m_BufferedRegion, and itk::SpatialObject< TDimension >::m_OffsetTable.

template<class TMesh >

bool itk::MeshSpatialObject< TMesh >::ComputeLocalBoundingBox ( void ) const

virtual

Compute the boundaries of the iamge spatial object.

Compute the bounds of the object which is the same as the internal mesh

Reimplemented from itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Definition at line 168 of file itkMeshSpatialObject.txx.

void itk::SpatialObject< TDimension >::ComputeObjectToParentTransform ( void )

inherited

Compute the Local transform when the global transform is set

Compute the Transform when the global tranform as been set This does not change the IndexToObjectMatrix

void itk::SpatialObject< TDimension >::ComputeObjectToWorldTransform ( void )

inherited

Compute the World transform when the local transform is set This function should be called each time the local transform has been modified

Compute the Global Transform

OffsetValueType itk::SpatialObject< TDimension >::ComputeOffset ( const IndexType & ind ) const

inlineinherited

Compute an offset from the beginning of the buffer for a pixel at the specified index.

Definition at line 291 of file itkSpatialObject.h.

References itk::ImageRegion< VImageDimension >::GetIndex(), itk::SpatialObject< TDimension >::m_BufferedRegion, and itk::SpatialObject< TDimension >::m_OffsetTable.

void itk::SpatialObject< TDimension >::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.

virtual void itk::SpatialObject< TDimension >::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.

Copy the information from another spatial object

Reimplemented from itk::DataObject.

template<class TMesh = Mesh<int>>

virtual::itk::LightObject::Pointer itk::MeshSpatialObject< TMesh >::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.

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.

virtual void itk::SpatialObject< TDimension >::DerivativeAt	(	const PointType &	point,
		short unsigned int	order,
		OutputVectorType &	value,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)

virtualinherited

Return the n-th order derivative value at the specified point.

Return the Derivative at a point given the order of the derivative

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.

bool itk::SpatialObject< TDimension >::Evaluate ( const PointType & point ) const

inlineinherited

Returns true if a point is inside the object - provided to make spatial objects compatible with spatial functions and conditional iterators for defining regions of interest.

Definition at line 207 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::IsInside().

virtual const AffineGeometryFrameType* itk::SpatialObject< TDimension >::GetAffineGeometryFrame ( )

virtualinherited

Set/Get the AffineGeometryFrame

virtual BoundingBoxType* itk::SpatialObject< TDimension >::GetBoundingBox ( void ) const

virtualinherited

Get the bounding box of the object. This function calls ComputeBoundingBox()

Get the bounds of the object

virtual const unsigned int& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenDepth ( )

virtualinherited

virtual const std::string& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenName ( )

virtualinherited

virtual const BoundingBoxType* itk::SpatialObject< TDimension >::GetBounds ( )

protectedvirtualinherited

virtual const RegionType& itk::SpatialObject< TDimension >::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 256 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_BufferedRegion.

virtual ChildrenListType* itk::SpatialObject< TDimension >::GetChildren	(	unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

virtualinherited

Returns a list of pointer to the children affiliated to this object. A depth of 0 returns the immediate childred. A depth of 1 returns the children and those children's children.

Warning: User is responsible for freeing the list, but not the elements of the list.

Get the children list. User is responsible for freeing the list, but not the elements of the list.

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

virtual double itk::SpatialObject< TDimension >::GetDefaultInsideValue ( ) const

virtualinherited

virtual double itk::SpatialObject< TDimension >::GetDefaultOutsideValue ( ) const

virtualinherited

virtual const unsigned int& itk::SpatialObject< TDimension >::GetDimension ( void )

protectedvirtualinherited

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.

virtual const int& itk::SpatialObject< TDimension >::GetId ( )

virtualinherited

Get/Set the ID

TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void )

inherited

Transform points from the internal data coordinate system of the object (typically the indices of the image from which the object was defined) to "physical" space (which accounts for the spacing, orientation, and offset of the indices)

Get the local transformation

const TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void ) const

inherited

Get the local transformation (const)

virtual TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform ( )

virtualinherited

virtual const TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform ( )

virtualinherited

virtual const TransformType* itk::SpatialObject< TDimension >::GetInternalInverseTransform ( )

protectedvirtualinherited

template<class TMesh = Mesh<int>>

virtual double itk::MeshSpatialObject< TMesh >::GetIsInsidePrecision ( )

virtual

virtual const RegionType& itk::SpatialObject< TDimension >::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 245 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_LargestPossibleRegion.

unsigned int itk::SpatialObject< TDimension >::GetMaximumDepth ( )

inlineinherited

Return the maximum depth that a tree of spatial objects can have. This provides convenient access to a static constant.

Definition at line 81 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::MaximumDepth.

template<class TMesh >

MeshSpatialObject< TMesh >::MeshType * itk::MeshSpatialObject< TMesh >::GetMesh ( void )

Get a pointer to the Mesh currently attached to the object.

Get the Mesh inside the spatial object

Definition at line 207 of file itkMeshSpatialObject.txx.

Referenced by itk::MetaMeshConverter< NDimensions, PixelType, TMeshTraits >::MeshSpatialObjectToMetaMesh().

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.

template<class TMesh >

unsigned long itk::MeshSpatialObject< TMesh >::GetMTime ( void ) const

virtual

Returns the latest modified time of the object and its component.

Get the modification time

Reimplemented from itk::Object.

Definition at line 228 of file itkMeshSpatialObject.txx.

template<class TMesh = Mesh<int>>

virtual const char* itk::MeshSpatialObject< TMesh >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void )

inherited

const TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void ) const

inherited

unsigned int itk::SpatialObject< TDimension >::GetNumberOfChildren	(	unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

inherited

Returns the number of children currently assigned to the object.

Get the number of children

unsigned int itk::SpatialObject< TDimension >::GetObjectDimension ( void ) const

inlineinherited

Get the dimensionality of the object

Definition at line 149 of file itkSpatialObject.h.

unsigned long itk::SpatialObject< TDimension >::GetObjectMTime ( void ) const

inlineinherited

Returns the latest modified time of the spatial object, but not the modification time of the children

Definition at line 226 of file itkSpatialObject.h.

References itk::Object::GetMTime().

TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void )

inherited

Transforms points from the object-specific "physical" space to the "physical" space of its parent object.

Get the local transformation

const TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void ) const

inherited

Get the local transformation (const)

TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform ( void )

inherited

Get the local transformation

const TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform ( void ) const

inherited

Get the local transformation (const)

virtual TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform ( )

virtualinherited

virtual const TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform ( )

virtualinherited

const OffsetValueType* itk::SpatialObject< TDimension >::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.

Definition at line 287 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_OffsetTable.

virtual const Self* itk::SpatialObject< TDimension >::GetParent ( void ) const

virtualinherited

Return a pointer to the parent object in the hierarchy tree

Get the parent of the spatial object

virtual Self* itk::SpatialObject< TDimension >::GetParent ( void )

virtualinherited

Return a pointer to the parent object in the hierarchy tree

Get the parent of the spatial object

virtual const int& itk::SpatialObject< TDimension >::GetParentId ( )

virtualinherited

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

virtualinherited

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

template<class TMesh = Mesh<int>>

const char* itk::MeshSpatialObject< TMesh >::GetPixelType ( )

inline

Return the type of pixel used

Definition at line 101 of file itkMeshSpatialObject.h.

PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void )

inherited

Returns a pointer to the property object applied to this class.

const PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void ) const

inlineinherited

Definition at line 375 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_Property.

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

virtual const RegionType& itk::SpatialObject< TDimension >::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 275 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_RequestedRegion.

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

virtual const double* itk::SpatialObject< TDimension >::GetSpacing ( void ) const

inlinevirtualinherited

Get the spacing of the spatial object.

Definition at line 404 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::GetIndexToObjectTransform(), and itk::ScalableAffineTransform< TScalarType, NDimensions >::GetScale().

virtual std::string itk::SpatialObject< TDimension >::GetSpatialObjectTypeAsString ( ) const

virtualinherited

Return the type of the spatial object as a string This is used by the SpatialObjectFactory

unsigned long itk::SpatialObject< TDimension >::GetTransformMTime ( void )

inherited

Return the Modified time of the LocalToWorldTransform

Return the Modified time of the LocalToGlobalTransform

virtual TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode ( )

virtualinherited

Return a raw pointer to the node container

virtual const TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode ( )

virtualinherited

virtual const char* itk::SpatialObject< TDimension >::GetTypeName ( void ) const

inlinevirtualinherited

Get the typename of the SpatialObject

Definition at line 141 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::m_TypeName.

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

virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

unsigned long itk::SpatialObject< TDimension >::GetWorldTransformMTime ( void )

inherited

Return the Modified time of the WorldToLocalTransform

Return the Modified time of the GlobalToLocalTransform

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

virtual void itk::DataObject::Graft ( const DataObject * )

inlinevirtualinherited

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

Definition at line 449 of file itkDataObject.h.

Referenced by otb::AtmosphericCorrectionParametersTo6SAtmosphericRadiativeTerms::GraftNthOutput(), otb::VectorDataSource< TOutputVectorData >::GraftNthOutput(), otb::PointSetSource< TOutputPointSet >::GraftNthOutput(), itk::MeshSource< TOutputMesh >::GraftNthOutput(), otb::ObjectListSource< TOutputList >::GraftNthOutput(), and itk::ImageSource< TOutputImage >::GraftNthOutput().

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.

virtual bool itk::SpatialObject< TDimension >::HasParent ( void ) const

virtualinherited

Return true if the object has a parent object. Basically, only the root object , or some isolated objects should return false.

Return true if the spatial object has a parent

void itk::DataObject::Initialize ( void )

virtualinherited

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

Definition at line 167 of file itkDataObject.cxx.

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.

template<class TMesh >

bool itk::MeshSpatialObject< TMesh >::IsEvaluableAt	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

Return true if the object is evaluable at the requested point, and else otherwise.

Return true if the given point is inside the Mesh

Definition at line 49 of file itkMeshSpatialObject.txx.

virtual bool itk::SpatialObject< TDimension >::IsEvaluableAt	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

virtualinherited

Returns true if the object can provide a "meaningful" value at a point. Often defaults to returning same answer as IsInside, but certain objects influence space beyond their spatial extent, e.g., an RFA Needle Spatial Object can cause a burn that extends beyond the tip of the needle.

Return if the object is evaluable at a point

template<class TMesh >

bool itk::MeshSpatialObject< TMesh >::IsInside	(	const PointType &	point,
		unsigned int	depth,
		char *	name
	)		const

Returns true if the point is inside, false otherwise.

Return true if the given point is inside the Mesh

Definition at line 116 of file itkMeshSpatialObject.txx.

References NULL.

template<class TMesh >

bool itk::MeshSpatialObject< TMesh >::IsInside ( const PointType & point ) const

virtual

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

Definition at line 61 of file itkMeshSpatialObject.txx.

References NULL.

virtual bool itk::SpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

virtualinherited

Returns true if a point is inside the object.

Return if a point is inside the object or its children

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 TMesh = Mesh<int>>

static Pointer itk::MeshSpatialObject< TMesh >::New ( )

static

Method for creation through the object factory.

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

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

protectedvirtual

Print the object

Reimplemented from itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Definition at line 216 of file itkMeshSpatialObject.txx.

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

void itk::SpatialObject< TDimension >::RemoveSpatialObject ( Self * object )

inherited

Remove the object passed as arguments from the list of children. May this function should return a false value if the object to remove is not found in the list.

Remove a child to the object

virtual bool itk::SpatialObject< TDimension >::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.

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.

virtual void itk::SpatialObject< TDimension >::SetAffineGeometryFrame ( AffineGeometryFrameType * _arg )

virtualinherited

virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenDepth ( unsigned int _arg )

virtualinherited

Set/Get the depth at which the bounding box is computed

virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenName ( std::string _arg )

virtualinherited

Set/Get the name of the children to consider when computing the bounding box

virtual void itk::SpatialObject< TDimension >::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()

void itk::SpatialObject< TDimension >::SetChildren ( ChildrenListType & children )

inherited

Set the list of pointers to children to the list passed as argument.

Set children list

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.

virtual void itk::SpatialObject< TDimension >::SetDefaultInsideValue ( double _arg )

virtualinherited

Set/Get the default inside value (ValueAt()) of the object. Default is 1.0

virtual void itk::SpatialObject< TDimension >::SetDefaultOutsideValue ( double _arg )

virtualinherited

Set/Get the default outside value (ValueAt()) of the object. Default is 0.0

virtual void itk::SpatialObject< TDimension >::SetDimension ( unsigned int _arg )

protectedvirtualinherited

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

virtual void itk::SpatialObject< TDimension >::SetId ( int _arg )

virtualinherited

bool itk::SpatialObject< TDimension >::SetInternalInverseTransformToWorldToIndexTransform ( ) const

protectedinherited

This convenience method take the IndexToWorldTransform, and if it can compute its inverse, then stores the result in the InternalInverse member variable, that can be later accessed with the method GetInternalInverseTransform(). This method is not exposed to users, it is only intended to be called internally by derived classes.

template<class TMesh = Mesh<int>>

virtual void itk::MeshSpatialObject< TMesh >::SetIsInsidePrecision ( double _arg )

virtual

Set/Get the precision for the IsInside function. This is used when the cell is a triangle, in this case, it's more likely that the given point will not be falling exactly on the triangle surface. If the distance from the point to the surface is <= to m_IsInsidePrecision the point is considered inside the mesh. The default value is 1.

virtual void itk::SpatialObject< TDimension >::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()

Set the largest possible region

template<class TMesh >

void itk::MeshSpatialObject< TMesh >::SetMesh ( MeshType * mesh )

Set the Mesh.

Set the Mesh in the spatial object

Definition at line 196 of file itkMeshSpatialObject.txx.

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

void itk::SpatialObject< TDimension >::SetNodeToParentNodeTransform ( TransformType * transform )

inherited

These function are just calling the node container transforms

void itk::SpatialObject< TDimension >::SetObjectToParentTransform ( TransformType * transform )

inherited

Transforms points from the object-specific "physical" space to the "physical" space of its parent object.

Set the local to global transformation

void itk::SpatialObject< TDimension >::SetObjectToWorldTransform ( TransformType * transform )

inherited

This defines the transformation from the global coordinate frame. By setting this transform, the local transform is computed

Set the global to local transformation

void itk::SpatialObject< TDimension >::SetParent ( Self * parent )

inherited

Set the pointer to the parent object in the tree hierarchy used for the spatial object patter.

Set the parent of the spatial object

virtual void itk::SpatialObject< TDimension >::SetParentId ( int _arg )

virtualinherited

Set/Get the parent Identification number

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

void itk::SpatialObject< TDimension >::SetProperty ( PropertyType * property )

inherited

Set the property applied to the object.

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.

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.

virtual void itk::SpatialObject< TDimension >::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).

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

virtual void itk::SpatialObject< TDimension >::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.

Reimplemented from itk::DataObject.

virtual void itk::SpatialObject< TDimension >::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.

void itk::SpatialObject< TDimension >::SetSpacing ( const double spacing[itkGetStaticConstMacro(ObjectDimension)] )

inlineinherited

Theses functions are just calling the AffineGeometryFrame functions Set the spacing of the spatial object.

Definition at line 400 of file itkSpatialObject.h.

References itk::SpatialObject< TDimension >::GetIndexToObjectTransform(), and itk::ScalableAffineTransform< TScalarType, NDimensions >::SetScale().

virtual void itk::SpatialObject< TDimension >::SetTreeNode ( TreeNodeType * _arg )

virtualinherited

Set the tree container

virtual void itk::SpatialObject< TDimension >::SetTypeName ( std::string _arg )

protectedvirtualinherited

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.

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

virtual void itk::SpatialObject< TDimension >::Update ( void )

virtualinherited

Specify that the object has been updated

Reimplemented from itk::DataObject.

void itk::DataObject::UpdateOutputData ( void )

virtualinherited

Definition at line 410 of file itkDataObject.cxx.

virtual void itk::SpatialObject< TDimension >::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.

Update the Output information

Reimplemented from itk::DataObject.

template<class TMesh >

bool itk::MeshSpatialObject< TMesh >::ValueAt	(	const PointType &	point,
		double &	value,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

Returns the value of the Mesh at the requested point. If the point is not inside the object, then an exception is thrown.

See Also: ExceptionObject

Return the value of the Mesh at a specified point The value returned is always of type double

Definition at line 140 of file itkMeshSpatialObject.txx.

virtual bool itk::SpatialObject< TDimension >::ValueAt	(	const PointType &	point,
		double &	value,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)		const

virtualinherited

Returns the value at a point

Return the value of the object at a point

virtual bool itk::SpatialObject< TDimension >::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.

Member Data Documentation

template<class TMesh = Mesh<int>>

const unsigned int itk::MeshSpatialObject< TMesh >::Dimension = TMesh::PointDimension

static

Definition at line 47 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

double itk::MeshSpatialObject< TMesh >::m_IsInsidePrecision

protected

Definition at line 119 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

MeshPointer itk::MeshSpatialObject< TMesh >::m_Mesh

protected

Definition at line 113 of file itkMeshSpatialObject.h.

template<class TMesh = Mesh<int>>

std::string itk::MeshSpatialObject< TMesh >::m_PixelType

protected

Definition at line 118 of file itkMeshSpatialObject.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.

const unsigned int itk::SpatialObject< TDimension >::MaximumDepth

staticinherited

Definition at line 77 of file itkSpatialObject.h.

const unsigned int itk::SpatialObject< TDimension >::ObjectDimension

staticinherited

Dimension of the object. This constant is used by functions that are templated over SpatialObject type when they need compile time access to the dimension of the object.

Definition at line 146 of file itkSpatialObject.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

Detailed Description

template<class TMesh = Mesh<int>> class itk::MeshSpatialObject< TMesh >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TMesh = Mesh<int>>
class itk::MeshSpatialObject< TMesh >