#include <itkMeshSource.h>

Detailed Description

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

Inheritance diagram for itk::MeshSource< TOutputMesh >:

Collaboration diagram for itk::MeshSource< TOutputMesh >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	OutputMeshPointer = typename OutputMeshType::Pointer

using	OutputMeshType = TOutputMesh

using	Pointer = SmartPointer< Self >

using	Self = MeshSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

OutputMeshType *	GetOutput ()

OutputMeshType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (DataObject *graft)


void	SetOutput (TOutputMesh *output)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	GenerateInputRequestedRegion () override

	MeshSource ()

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

	~MeshSource () override=default

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	VerifyPreconditions () ITKv5_CONST

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

virtual	~LightObject ()

Private Attributes
int	m_GenerateDataNumberOfRegions {}

int	m_GenerateDataRegion {}

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

Additional Inherited Members
Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkMeshSource.h.

◆ DataObjectIdentifierType

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::DataObjectIdentifierType = Superclass::DataObjectIdentifierType

Definition at line 71 of file itkMeshSource.h.

◆ DataObjectPointer

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::DataObjectPointer = DataObject::Pointer

Some convenient type alias.

Definition at line 67 of file itkMeshSource.h.

◆ DataObjectPointerArraySizeType

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::DataObjectPointerArraySizeType = ProcessObject::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().

Definition at line 149 of file itkMeshSource.h.

◆ OutputMeshPointer

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::OutputMeshPointer = typename OutputMeshType::Pointer

Definition at line 69 of file itkMeshSource.h.

◆ OutputMeshType

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::OutputMeshType = TOutputMesh

Definition at line 68 of file itkMeshSource.h.

◆ Pointer

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkMeshSource.h.

◆ Self

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::Self = MeshSource

Standard class type aliases.

Definition at line 55 of file itkMeshSource.h.

◆ Superclass

template<typename TOutputMesh>

using itk::MeshSource< TOutputMesh >::Superclass = ProcessObject

Definition at line 56 of file itkMeshSource.h.

Constructor & Destructor Documentation

◆ MeshSource()

template<typename TOutputMesh>

itk::MeshSource< TOutputMesh >::MeshSource ( )

protected

◆ ~MeshSource()

template<typename TOutputMesh>

itk::MeshSource< TOutputMesh >::~MeshSource ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateInputRequestedRegion()

template<typename TOutputMesh>

void itk::MeshSource< TOutputMesh >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

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.

◆ GetNameOfClass()

template<typename TOutputMesh>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetOutput() [1/2]

template<typename TOutputMesh>

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

Get the mesh output of this process object.

Referenced by itk::DiscretePrincipalCurvaturesQuadEdgeMeshFilter< TInputMesh, TOutputMesh >::ComputeMeanAndGaussianCurvatures().

◆ GetOutput() [2/2]

template<typename TOutputMesh>

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

◆ GraftNthOutput()

template<typename TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	graft
	)

virtual

◆ GraftOutput() [1/2]

template<typename TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftOutput	(	const DataObjectIdentifierType &	key,
		DataObject *	graft
	)

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.

◆ GraftOutput() [2/2]

template<typename TOutputMesh>

virtual void itk::MeshSource< TOutputMesh >::GraftOutput ( DataObject * graft )

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

◆ MakeOutput()

template<typename TOutputMesh>

DataObjectPointer itk::MeshSource< TOutputMesh >::MakeOutput ( DataObjectPointerArraySizeType idx )

overridevirtual

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.

◆ New()

template<typename TOutputMesh>

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputMesh>

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

overrideprotectedvirtual

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.

◆ SetOutput()

template<typename TOutputMesh>

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

Member Data Documentation

◆ m_GenerateDataNumberOfRegions

template<typename TOutputMesh>

int itk::MeshSource< TOutputMesh >::m_GenerateDataNumberOfRegions {}

private

Definition at line 171 of file itkMeshSource.h.

◆ m_GenerateDataRegion

template<typename 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 170 of file itkMeshSource.h.

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

itkMeshSource.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ OutputMeshPointer

◆ OutputMeshType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MeshSource()

◆ ~MeshSource()

Member Function Documentation

◆ GenerateInputRequestedRegion()

◆ GetNameOfClass()

◆ GetOutput() [1/2]

◆ GetOutput() [2/2]

◆ GraftNthOutput()

◆ GraftOutput() [1/2]

◆ GraftOutput() [2/2]

◆ MakeOutput()

◆ New()

◆ PrintSelf()

◆ SetOutput()

Member Data Documentation

◆ m_GenerateDataNumberOfRegions

◆ m_GenerateDataRegion

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