Base class for all process objects that output mesh data. More...

#include <itkMeshSource.h>

Inheritance diagram for itk::MeshSource< TOutputMesh >:

Collaboration diagram for itk::MeshSource< TOutputMesh >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef OutputMeshType::Pointer	OutputMeshPointer
typedef TOutputMesh	OutputMeshType
typedef SmartPointer< Self >	Pointer
typedef MeshSource	Self
typedef ProcessObject	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
OutputMeshType *	GetOutput (unsigned int idx)
OutputMeshType *	GetOutput (void)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

void	SetOutput (TOutputMesh *output)

virtual void	GraftOutput (DataObject *output)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	GenerateInputRequestedRegion ()
	MeshSource ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MeshSource ()
Private Member Functions
	MeshSource (const Self &)
void	operator= (const Self &)
Private Attributes
int	m_GenerateDataNumberOfRegions
int	m_GenerateDataRegion
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

Detailed Description

template<class TOutputMesh>
class itk::MeshSource< TOutputMesh >

Base class for all process objects that output mesh data.

MeshSource is the base class for all process objects that output mesh data. Specifically, this class defines the GetOutput() method that returns a pointer to the output mesh. The class also defines some internal private data members that are used to manage streaming of data.

Definition at line 49 of file itkMeshSource.h.

Member Typedef Documentation

template<class TOutputMesh>

typedef SmartPointer< const Self > itk::MeshSource< TOutputMesh >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 56 of file itkMeshSource.h.

template<class TOutputMesh>

typedef Superclass::DataObjectIdentifierType itk::MeshSource< TOutputMesh >::DataObjectIdentifierType

Reimplemented from itk::ProcessObject.

Definition at line 69 of file itkMeshSource.h.

template<class TOutputMesh>

typedef DataObject::Pointer itk::MeshSource< TOutputMesh >::DataObjectPointer

Some convenient typedefs.

Reimplemented from itk::ProcessObject.

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

Definition at line 62 of file itkMeshSource.h.

template<class TOutputMesh>

typedef ProcessObject::DataObjectPointerArraySizeType itk::MeshSource< TOutputMesh >::DataObjectPointerArraySizeType

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

Definition at line 142 of file itkMeshSource.h.

template<class TOutputMesh>

typedef OutputMeshType::Pointer itk::MeshSource< TOutputMesh >::OutputMeshPointer

Definition at line 67 of file itkMeshSource.h.

template<class TOutputMesh>

typedef TOutputMesh itk::MeshSource< TOutputMesh >::OutputMeshType

Definition at line 66 of file itkMeshSource.h.

template<class TOutputMesh>

typedef SmartPointer< Self > itk::MeshSource< TOutputMesh >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 55 of file itkMeshSource.h.

template<class TOutputMesh>

typedef MeshSource itk::MeshSource< TOutputMesh >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 53 of file itkMeshSource.h.

template<class TOutputMesh>

typedef ProcessObject itk::MeshSource< TOutputMesh >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 54 of file itkMeshSource.h.

Constructor & Destructor Documentation

template<class TOutputMesh>

itk::MeshSource< TOutputMesh >::MeshSource ( ) [protected]

template<class TOutputMesh>

virtual itk::MeshSource< TOutputMesh >::~MeshSource ( ) [inline, protected, virtual]

Definition at line 149 of file itkMeshSource.h.

template<class TOutputMesh>

itk::MeshSource< TOutputMesh >::MeshSource ( const Self & ) [private]

Member Function Documentation

template<class TOutputMesh>

virtual::itk::LightObject::Pointer itk::MeshSource< TOutputMesh >::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.

template<class TOutputMesh>

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

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.

template<class TOutputMesh>

virtual const char* itk::MeshSource< TOutputMesh >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TOutputMesh>

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

Get the mesh output of this process object.

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

template<class TOutputMesh>

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

template<class TOutputMesh>

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

template<class TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftOutput	(	const DataObjectIdentifierType &	key,
		DataObject *	output
	)		`[virtual]`

Graft the specified data object onto this ProcessObject's named output. This is similar to the GraftOutput method except it allows you to specify which output is affected. See the GraftOutput for general usage information.

template<class TOutputMesh>

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

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 DataObjectPointer itk::MeshSource< TOutputMesh >::MakeOutput ( DataObjectPointerArraySizeType idx ) [virtual]

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

template<class TOutputMesh>

static Pointer itk::MeshSource< TOutputMesh >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TOutputMesh>

void itk::MeshSource< TOutputMesh >::operator= ( const Self & ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

template<class TOutputMesh>

void itk::MeshSource< 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::ProcessObject.

template<class TOutputMesh>

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

Member Data Documentation

template<class TOutputMesh>

int itk::MeshSource< TOutputMesh >::m_GenerateDataNumberOfRegions [private]

Definition at line 164 of file itkMeshSource.h.

template<class TOutputMesh>

int itk::MeshSource< TOutputMesh >::m_GenerateDataRegion [private]

Used by streaming: The requested region of the output being processed by the execute method. Set in the GenerateInputRequestedRegion method.

Definition at line 163 of file itkMeshSource.h.

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

itkMeshSource.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<class TOutputMesh> class itk::MeshSource< TOutputMesh >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TOutputMesh>
class itk::MeshSource< TOutputMesh >