Extract portions of a mesh that are connected at vertices. More...

#include <itkConnectedRegionsMeshFilter.h>

Inheritance diagram for itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >:

Collaboration diagram for itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >:

Public Types
enum	{ PointSeededRegions = 0, CellSeededRegions = 1, SpecifiedRegions = 2, LargestRegion = 3, AllRegions = 4, ClosestPointRegion = 5 }
typedef InputMeshType::CellDataContainer::ConstIterator	CellDataContainerConstIterator
typedef InputMeshType::CellsContainer::ConstIterator	CellsContainerConstIterator
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef TInputMesh::CellDataContainer	InputMeshCellDataContainer
typedef TInputMesh::CellDataContainerConstPointer	InputMeshCellDataContainerConstPointer
typedef TInputMesh::CellDataContainerPointer	InputMeshCellDataContainerPointer
typedef TInputMesh::CellIdentifier	InputMeshCellIdentifier
typedef TInputMesh::PointCellLinksContainer	InputMeshCellLinksContainer
typedef TInputMesh::CellLinksContainerConstPointer	InputMeshCellLinksContainerConstPointer
typedef TInputMesh::CellAutoPointer	InputMeshCellPointer
typedef TInputMesh::CellsContainer	InputMeshCellsContainer
typedef TInputMesh::CellsContainerConstPointer	InputMeshCellsContainerConstPointer
typedef TInputMesh::CellsContainerPointer	InputMeshCellsContainerPointer
typedef TInputMesh::ConstPointer	InputMeshConstPointer
typedef InputMeshType::Pointer	InputMeshPointer
typedef TInputMesh::CellTraits::PointIdConstIterator	InputMeshPointIdConstIterator
typedef TInputMesh::PointIdentifier	InputMeshPointIdentifier
typedef TInputMesh::PointsContainerConstPointer	InputMeshPointsContainerConstPointer
typedef TInputMesh::PointType	InputMeshPointType
typedef TInputMesh	InputMeshType
typedef TOutputMesh::Pointer	OutputMeshPointer
typedef TOutputMesh	OutputMeshType
typedef SmartPointer< Self >	Pointer
typedef InputMeshType::PointsContainer::ConstIterator	PointsContainerConstIterator
typedef ConnectedRegionsMeshFilter	Self
typedef MeshToMeshFilter < TInputMesh, TOutputMesh >	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DeleteSeed (unsigned long id)
void	DeleteSpecifiedRegion (unsigned long id)
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
InputMeshPointType &	GetClosestPoint (InputMeshPointType &p)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
unsigned long	GetNumberOfExtractedRegions ()
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetExtractionModeToAllRegions (void)
void	SetExtractionModeToCellSeededRegions (void)
void	SetExtractionModeToClosestPointRegion (void)
void	SetExtractionModeToLargestRegion (void)
void	SetExtractionModeToPointSeededRegions (void)
void	SetExtractionModeToSpecifiedRegions (void)
void	SetInput (const InputMeshType *input)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetOutput (TOutputMesh *output)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


virtual void	SetExtractionMode (int _arg)
virtual int	GetExtractionMode () const


void	InitializeSeedList (void)


void	AddSeed (unsigned long id)


void	InitializeSpecifiedRegionList (void)


void	AddSpecifiedRegion (unsigned long id)


void	SetClosestPoint (InputMeshPointType &p)


const InputMeshType *	GetInput (void) const
const InputMeshType *	GetInput (unsigned int idx) const


OutputMeshType *	GetOutput (void)
OutputMeshType *	GetOutput (unsigned int idx)


virtual void	GraftOutput (DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()


virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()


virtual void	SetNumberOfThreads (int _arg)
virtual const int &	GetNumberOfThreads ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	PointDimension = TInputMesh::PointDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
	ConnectedRegionsMeshFilter (void)
void	CopyInputMeshToOutputMeshCellData ()
void	CopyInputMeshToOutputMeshCellLinks ()
void	CopyInputMeshToOutputMeshCells ()
void	CopyInputMeshToOutputMeshPointData ()
void	CopyInputMeshToOutputMeshPoints ()
virtual void	GenerateData (void)
void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
void	PropagateConnectedWave (void)
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual	~ConnectedRegionsMeshFilter (void)


DataObject *	GetInput (unsigned int idx)


const DataObject *	GetOutput (unsigned int idx) const


virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	RemoveInput (DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredInputs ()


virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()


virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

Detailed Description

template<class TInputMesh, class TOutputMesh>
class itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >

Extract portions of a mesh that are connected at vertices.

ConnectedRegionsMeshFilter will extract portions of a mesh that are connected at vertices. (Such connected portions of the mesh are referred to as a region.) Options exist to extract the largest region, a particular region, a region containing a specified point, or a region containing a specified cell.

Definition at line 41 of file itkConnectedRegionsMeshFilter.h.

Member Typedef Documentation

template<class TInputMesh , class TOutputMesh >

typedef InputMeshType::CellDataContainer::ConstIterator itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::CellDataContainerConstIterator

Definition at line 96 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef InputMeshType::CellsContainer::ConstIterator itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::CellsContainerConstIterator

Definition at line 94 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef SmartPointer<const Self> itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::ConstPointer

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 59 of file itkConnectedRegionsMeshFilter.h.

template<class TOutputMesh>

typedef DataObject::Pointer itk::MeshSource< TOutputMesh >::DataObjectPointer [inherited]

Some convenient typedefs.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >.

Definition at line 56 of file itkMeshSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellDataContainer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellDataContainer

Definition at line 86 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellDataContainerConstPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellDataContainerConstPointer

Definition at line 90 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellDataContainerPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellDataContainerPointer

Definition at line 88 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellIdentifier itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellIdentifier

Definition at line 104 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::PointCellLinksContainer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellLinksContainer

Definition at line 103 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellLinksContainerConstPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellLinksContainerConstPointer

Definition at line 101 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellAutoPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellPointer

Definition at line 97 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellsContainer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellsContainer

Definition at line 81 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellsContainerConstPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellsContainerConstPointer

Definition at line 85 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellsContainerPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshCellsContainerPointer

Definition at line 83 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::ConstPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshConstPointer

Definition at line 71 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh, class TOutputMesh>

typedef InputMeshType::Pointer itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::InputMeshPointer [inherited]

Definition at line 56 of file itkMeshToMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::CellTraits::PointIdConstIterator itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshPointIdConstIterator

Definition at line 99 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::PointIdentifier itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshPointIdentifier

Definition at line 78 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::PointsContainerConstPointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshPointsContainerConstPointer

Definition at line 80 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh::PointType itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshPointType

Definition at line 77 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TInputMesh itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InputMeshType

Convenient typedefs for this filter.

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 64 of file itkConnectedRegionsMeshFilter.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 TInputMesh , class TOutputMesh >

typedef TOutputMesh::Pointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::OutputMeshPointer

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 72 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef TOutputMesh itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::OutputMeshType

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 70 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef SmartPointer<Self> itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::Pointer

Smart pointer typedef support

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 58 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef InputMeshType::PointsContainer::ConstIterator itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::PointsContainerConstIterator

Definition at line 92 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef ConnectedRegionsMeshFilter itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::Self

Standard class typedefs.

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 48 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

typedef MeshToMeshFilter<TInputMesh, TOutputMesh> itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::Superclass

Standard "Superclass" typedef.

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

Definition at line 53 of file itkConnectedRegionsMeshFilter.h.

Member Enumeration Documentation

template<class TInputMesh , class TOutputMesh >

anonymous enum

Different modes of operation. Use these to specify how to extract the regions.

Enumerator:

PointSeededRegions
CellSeededRegions
SpecifiedRegions
LargestRegion
AllRegions
ClosestPointRegion

Definition at line 110 of file itkConnectedRegionsMeshFilter.h.

Constructor & Destructor Documentation

template<class TInputMesh , class TOutputMesh >

itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::ConnectedRegionsMeshFilter ( void ) [protected]

template<class TInputMesh , class TOutputMesh >

virtual itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::~ConnectedRegionsMeshFilter ( void ) [inline, protected, virtual]

Definition at line 237 of file itkConnectedRegionsMeshFilter.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

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

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

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSeed ( unsigned long id ) [inline]

Add a seed id (point or cell id). Note: ids are 0-offset.

Definition at line 170 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSpecifiedRegion ( unsigned long id ) [inline]

Add a region id to extract. Note: ids are 0-offset.

Definition at line 195 of file itkConnectedRegionsMeshFilter.h.

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

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

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

template<class TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::CopyInputMeshToOutputMeshCellData ( ) [protected, inherited]

Reimplemented in itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInputMesh, TOutputMesh >, and itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInput, TOutput >.

template<class TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::CopyInputMeshToOutputMeshCellLinks ( ) [protected, inherited]

template<class TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::CopyInputMeshToOutputMeshCells ( ) [protected, inherited]

Reimplemented in itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInputMesh, TOutputMesh >, and itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInput, TOutput >.

template<class TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::CopyInputMeshToOutputMeshPointData ( ) [protected, inherited]

Reimplemented in itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInputMesh, TOutputMesh >, and itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInput, TOutput >.

template<class TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::CopyInputMeshToOutputMeshPoints ( ) [protected, inherited]

Reimplemented in itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInputMesh, TOutputMesh >, and itk::QuadEdgeMeshToQuadEdgeMeshFilter< TInput, TOutput >.

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 TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::DeleteSeed ( unsigned long id )

Delete a seed id (point or cell id). Note: ids are 0-offset.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::DeleteSpecifiedRegion ( unsigned long id )

Delete a region id to extract. Note: ids are 0-offset.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

template<class TInputMesh , class TOutputMesh >

virtual void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::GenerateData ( void ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TOutputMesh>

void itk::MeshSource< TOutputMesh >::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

Requested region of Mesh is specified as i of N unstructured regions. Since all DataObjects should be able to set the requested region in unstructured form, just copy output->RequestedRegion all inputs.

Reimplemented from itk::ProcessObject.

virtual void itk::ProcessObject::GenerateOutputInformation ( ) [protected, virtual, inherited]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputMesh , class TOutputMesh >

InputMeshPointType& itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::GetClosestPoint ( InputMeshPointType & p ) [inline]

Definition at line 221 of file itkConnectedRegionsMeshFilter.h.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

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

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

Get the value of the debug flag.

template<class TInputMesh , class TOutputMesh >

virtual int itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::GetExtractionMode ( ) const [virtual]

Methods specify mode of operation for the filter. Note that some modes require additional information. For example, SetExtractionModeToClosestPointRegion() also requires that a point be defined.

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 TInputMesh, class TOutputMesh>

const InputMeshType* itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::GetInput ( unsigned int idx ) const [inherited]

Get the mesh input of this process object.

Reimplemented from itk::ProcessObject.

template<class TInputMesh, class TOutputMesh>

const InputMeshType* itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::GetInput ( void ) const [inherited]

Get the mesh input of this process object.

DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an input.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Returns:: A constant reference to this objects MetaDataDictionary.

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

Return this objects modified time.

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

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TInputMesh, class TOutputMesh>

virtual const char* itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::GetNameOfClass ( ) const [virtual, inherited]

Run-time type information (and related methods).

Reimplemented from itk::MeshSource< TOutputMesh >.

template<class TInputMesh , class TOutputMesh >

unsigned long itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::GetNumberOfExtractedRegions ( ) [inline]

Obtain the number of connected regions.

Definition at line 229 of file itkConnectedRegionsMeshFilter.h.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

Get/Set the number of threads to create when executing.

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TOutputMesh>

OutputMeshType* itk::MeshSource< TOutputMesh >::GetOutput ( unsigned int idx ) [inherited]

Get the mesh output of this process object.

Reimplemented from itk::ProcessObject.

template<class TOutputMesh>

OutputMeshType* itk::MeshSource< TOutputMesh >::GetOutput ( void ) [inherited]

Get the mesh output of this process object.

Reimplemented in itk::ImageToMeshFilter< TInputImage, TOutputMesh >.

Referenced by itk::QuadEdgeMeshDiscretePrincipalCurvaturesEstimator< TInputMesh, TOutputMesh >::ComputeMeanAndGaussianCurvatures(), itk::QuadEdgeMeshDiscreteCurvatureEstimator< TInputMesh, TOutputMesh >::ComputeMixedArea(), itk::QuadEdgeMeshDiscreteMeanCurvatureEstimator< TInputMesh, TOutputMesh >::EstimateCurvature(), itk::QuadEdgeMeshDiscreteGaussianCurvatureEstimator< TInputMesh, TOutputMesh >::EstimateCurvature(), and itk::QuadEdgeMeshDiscreteCurvatureEstimator< TInputMesh, TOutputMesh >::GenerateData().

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an output.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::XMLFilterWatcher::ShowProgress().

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

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

template<class TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

template<class TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftOutput ( DataObject * output ) [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

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

Return true if an observer is registered for this event.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSeedList ( void ) [inline]

Initialize list of point ids/cell ids used to seed regions.

Definition at line 160 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSpecifiedRegionList ( void ) [inline]

Initialize list of region ids to extract.

Definition at line 185 of file itkConnectedRegionsMeshFilter.h.

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

Call Execute on all the Commands observing this event id.

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.

template<class TOutputMesh>

virtual DataObjectPointer itk::MeshSource< TOutputMesh >::MakeOutput ( unsigned int idx ) [virtual, inherited]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of MeshSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Reimplemented in itk::ImageToMeshFilter< TInputImage, TOutputMesh >.

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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputMesh , class TOutputMesh >

static Pointer itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::MeshToMeshFilter< TInputMesh, TOutputMesh >.

virtual void itk::ProcessObject::PopBackInput ( ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PopFrontInput ( ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

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 TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::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::MeshSource< TOutputMesh >.

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.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::PropagateConnectedWave ( void ) [protected]

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

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

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

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 256 of file itkProcessObject.h.

virtual void itk::ProcessObject::ReleaseInputs ( ) [protected, virtual, inherited]

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

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

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

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

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetClosestPoint ( InputMeshPointType & p ) [inline]

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

Definition at line 211 of file itkConnectedRegionsMeshFilter.h.

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

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

template<class TInputMesh , class TOutputMesh >

virtual void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionMode ( int _arg ) [virtual]

Methods specify mode of operation for the filter. Note that some modes require additional information. For example, SetExtractionModeToClosestPointRegion() also requires that a point be defined.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToAllRegions ( void ) [inline]

Definition at line 147 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToCellSeededRegions ( void ) [inline]

Definition at line 132 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToClosestPointRegion ( void ) [inline]

Definition at line 152 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToLargestRegion ( void ) [inline]

Definition at line 142 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToPointSeededRegions ( void ) [inline]

Definition at line 127 of file itkConnectedRegionsMeshFilter.h.

template<class TInputMesh , class TOutputMesh >

void itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetExtractionModeToSpecifiedRegions ( void ) [inline]

Definition at line 137 of file itkConnectedRegionsMeshFilter.h.

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 TInputMesh, class TOutputMesh>

void itk::MeshToMeshFilter< TInputMesh, TOutputMesh >::SetInput ( const InputMeshType * input ) [inherited]

Set the mesh input of this process object.

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

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs. Subclasses make use of them for setting input.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

template<class TOutputMesh>

void itk::MeshSource< TOutputMesh >::SetOutput ( TOutputMesh * output ) [inherited]

Set the mesh output of this process object. This call is slated to be removed from ITK. You should GraftOutput() and possible DataObject::DisconnectPipeline() to properly change the output.

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented in itk::watershed::Segmenter< TInputImage >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

Member Data Documentation

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.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.

bool itk::ProcessObject::m_Updating [protected, inherited]

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

template<class TInputMesh , class TOutputMesh >

const unsigned int itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::PointDimension = TInputMesh::PointDimension [static]

Definition at line 75 of file itkConnectedRegionsMeshFilter.h.

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

itkConnectedRegionsMeshFilter.h

itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh > Class Template Reference [Mesh Filters]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class TInputMesh, class TOutputMesh> class itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh > Class Template Reference
[Mesh Filters]

template<class TInputMesh, class TOutputMesh>
class itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >