#include <itkPathSource.h>

Inheritance diagram for itk::PathSource< TOutputPath >:

Collaboration diagram for itk::PathSource< TOutputPath >:

Detailed Description

template<typename TOutputPath>
class itk::PathSource< TOutputPath >

Base class for all process objects that output path data.

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

Definition at line 41 of file itkPathSource.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef OutputPathType::IndexType	OutputPathIndexType

typedef OutputPathType::InputType	OutputPathInputType

typedef OutputPathType::OffsetType	OutputPathOffsetType

typedef OutputPathType::OutputType	OutputPathOutputType

typedef OutputPathType::Pointer	OutputPathPointer

typedef TOutputPath	OutputPathType

typedef SmartPointer< Self >	Pointer

typedef PathSource	Self

typedef ProcessObject	Superclass

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

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

OutputPathType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, OutputPathType *output)


OutputPathType *	GetOutput ()


virtual void	GraftOutput (OutputPathType *output)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

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

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

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

static Pointer	New ()

Protected Member Functions
	PathSource ()

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

virtual	~PathSource ()

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

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

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

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

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 num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation ()

virtual void	VerifyPreconditions ()

	~ProcessObject ()

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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 Member Functions
void	operator= (const Self &) ITK_DELETE_FUNCTION

	PathSource (const Self &) ITK_DELETE_FUNCTION

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TOutputPath>

typedef SmartPointer< const Self > itk::PathSource< TOutputPath >::ConstPointer

Definition at line 48 of file itkPathSource.h.

template<typename TOutputPath>

typedef DataObject::Pointer itk::PathSource< TOutputPath >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 51 of file itkPathSource.h.

template<typename TOutputPath>

typedef ProcessObject::DataObjectPointerArraySizeType itk::PathSource< TOutputPath >::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 ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Definition at line 171 of file itkPathSource.h.

template<typename TOutputPath>

typedef OutputPathType::IndexType itk::PathSource< TOutputPath >::OutputPathIndexType

Definition at line 64 of file itkPathSource.h.

template<typename TOutputPath>

typedef OutputPathType::InputType itk::PathSource< TOutputPath >::OutputPathInputType

Definition at line 62 of file itkPathSource.h.

template<typename TOutputPath>

typedef OutputPathType::OffsetType itk::PathSource< TOutputPath >::OutputPathOffsetType

Definition at line 65 of file itkPathSource.h.

template<typename TOutputPath>

typedef OutputPathType::OutputType itk::PathSource< TOutputPath >::OutputPathOutputType

Definition at line 63 of file itkPathSource.h.

template<typename TOutputPath>

typedef OutputPathType::Pointer itk::PathSource< TOutputPath >::OutputPathPointer

Definition at line 61 of file itkPathSource.h.

template<typename TOutputPath>

typedef TOutputPath itk::PathSource< TOutputPath >::OutputPathType

Some convenient typedefs.

Definition at line 57 of file itkPathSource.h.

template<typename TOutputPath>

typedef SmartPointer< Self > itk::PathSource< TOutputPath >::Pointer

Definition at line 47 of file itkPathSource.h.

template<typename TOutputPath>

typedef PathSource itk::PathSource< TOutputPath >::Self

Standard class typedefs.

Definition at line 45 of file itkPathSource.h.

template<typename TOutputPath>

typedef ProcessObject itk::PathSource< TOutputPath >::Superclass

Definition at line 46 of file itkPathSource.h.

Constructor & Destructor Documentation

template<typename TOutputPath>

itk::PathSource< TOutputPath >::PathSource ( )

protected

template<typename TOutputPath>

virtual itk::PathSource< TOutputPath >::~PathSource ( )

inlineprotectedvirtual

Definition at line 178 of file itkPathSource.h.

template<typename TOutputPath>

itk::PathSource< TOutputPath >::PathSource ( const Self & )

private

Member Function Documentation

template<typename TOutputPath>

virtual::itk::LightObject::Pointer itk::PathSource< TOutputPath >::CreateAnother ( ) 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.

Reimplemented in itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >, itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.

template<typename TOutputPath>

virtual const char* itk::PathSource< TOutputPath >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >, itk::ContourExtractor2DImageFilter< TInputImage >, itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >, itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >, itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, itk::ImageToPathFilter< TInputImage, TOutputPath >, itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >, itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >, itk::PathToChainCodePathFilter< TInputPath, TOutputChainCodePath >, itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >, itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.

template<typename TOutputPath>

OutputPathType* itk::PathSource< TOutputPath >::GetOutput ( )

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

*   anotherFilter->SetInput( someFilter->GetOutput() );
*   anotherFilter->Update();
* 

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

*   image = someFilter->GetOutput();
*   image->Update();
* 

*   someFilter->Update();
*   image = someFilter->GetOutput();
* 

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

template<typename TOutputPath>

OutputPathType* itk::PathSource< TOutputPath >::GetOutput ( unsigned int idx )

template<typename TOutputPath>

virtual void itk::PathSource< TOutputPath >::GraftNthOutput	(	unsigned int	idx,
		OutputPathType *	output
	)

virtual

Graft the specified data object onto this ProcessObject's idx'th output. This is the similar to GraftOutput method except is allows you specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfIndexedOutputs()). See the GraftOutput for general usage information.

template<typename TOutputPath>

virtual void itk::PathSource< TOutputPath >::GraftOutput ( OutputPathType * output )

virtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's path data to use as its output's own path 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 GeneratseInputRequestedRegion(), 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<typename TOutputPath>

virtual DataObjectPointer itk::PathSource< TOutputPath >::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 ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<typename TOutputPath>

static Pointer itk::PathSource< TOutputPath >::New ( )

static

Method for creation through the object factory.

template<typename TOutputPath>

void itk::PathSource< TOutputPath >::operator= ( const Self & )

private

template<typename TOutputPath>

virtual void itk::PathSource< TOutputPath >::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.

Reimplemented in itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >, itk::ContourExtractor2DImageFilter< TInputImage >, itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >, itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >, itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >, itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >, itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, itk::ImageToPathFilter< TInputImage, TOutputPath >, itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >, itk::PathToChainCodePathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.

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

itkPathSource.h

Detailed Description

template<typename TOutputPath> class itk::PathSource< TOutputPath >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename TOutputPath>
class itk::PathSource< TOutputPath >