#include <itkPathToPathFilter.h>

Inheritance diagram for itk::PathToPathFilter< TInputPath, TOutputPath >:

Collaboration diagram for itk::PathToPathFilter< TInputPath, TOutputPath >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputPathConstPointer = typename InputPathType::ConstPointer

using	InputPathPointer = typename InputPathType::Pointer

using	InputPathType = TInputPath

using	Pointer = SmartPointer< Self >

using	Self = PathToPathFilter

using	Superclass = PathSource< TOutputPath >

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

using	DataObjectPointer = DataObject::Pointer

using	OutputPathIndexType = typename OutputPathType::IndexType

using	OutputPathInputType = typename OutputPathType::InputType

using	OutputPathOffsetType = typename OutputPathType::OffsetType

using	OutputPathOutputType = typename OutputPathType::OutputType

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = TOutputPath

using	Pointer = SmartPointer< Self >

using	Self = PathSource

using	Superclass = ProcessObject

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

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

const InputPathType *	GetInput ()

const InputPathType *	GetInput (unsigned int idx)

virtual const char *	GetNameOfClass () const

virtual void	SetInput (const InputPathType *path)

virtual void	SetInput (unsigned int, const TInputPath *path)

Public Member Functions inherited from itk::PathSource< TOutputPath >
OutputPathType *	GetOutput ()

OutputPathType *	GetOutput (unsigned int idx)

virtual void	GraftOutput (OutputPathType *graft)

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

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

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

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

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

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::PathSource< TOutputPath >
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
	PathToPathFilter ()

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

	~PathToPathFilter () override=default


void	GenerateInputRequestedRegion () override

Protected Member Functions inherited from itk::PathSource< TOutputPath >
	PathSource ()

	~PathSource () override=default

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	GenerateData ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

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
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

Detailed Description

template<typename TInputPath, typename TOutputPath>
class itk::PathToPathFilter< TInputPath, TOutputPath >

Base class for filters that take a path as input and produce a path as output.

PathToPathFilter is the base class for all process objects that output path data and require path data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

Definition at line 38 of file itkPathToPathFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::ConstPointer = SmartPointer<const Self>

Definition at line 47 of file itkPathToPathFilter.h.

◆ InputPathConstPointer

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathConstPointer = typename InputPathType::ConstPointer

Definition at line 58 of file itkPathToPathFilter.h.

◆ InputPathPointer

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathPointer = typename InputPathType::Pointer

Definition at line 57 of file itkPathToPathFilter.h.

◆ InputPathType

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathType = TInputPath

Some convenient type alias.

Definition at line 56 of file itkPathToPathFilter.h.

◆ Pointer

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::Pointer = SmartPointer<Self>

Definition at line 46 of file itkPathToPathFilter.h.

◆ Self

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::Self = PathToPathFilter

Standard class type aliases.

Definition at line 44 of file itkPathToPathFilter.h.

◆ Superclass

template<typename TInputPath, typename TOutputPath>

using itk::PathToPathFilter< TInputPath, TOutputPath >::Superclass = PathSource<TOutputPath>

Definition at line 45 of file itkPathToPathFilter.h.

Constructor & Destructor Documentation

◆ PathToPathFilter()

template<typename TInputPath, typename TOutputPath>

itk::PathToPathFilter< TInputPath, TOutputPath >::PathToPathFilter ( )

protected

◆ ~PathToPathFilter()

template<typename TInputPath, typename TOutputPath>

itk::PathToPathFilter< TInputPath, TOutputPath >::~PathToPathFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputPath, typename TOutputPath>

virtual::itk::LightObject::Pointer itk::PathToPathFilter< TInputPath, 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::PathSource< TOutputPath >.

◆ GenerateInputRequestedRegion()

template<typename TInputPath, typename TOutputPath>

void itk::PathToPathFilter< TInputPath, TOutputPath >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? Up till and including now, the base assumption is that the largest possible region will be requested of the input. If this method is overridden, the new method should call its superclass' implementation as its first step.

See also: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetInput() [1/2]

template<typename TInputPath, typename TOutputPath>

const InputPathType* itk::PathToPathFilter< TInputPath, TOutputPath >::GetInput ( )

◆ GetInput() [2/2]

template<typename TInputPath, typename TOutputPath>

const InputPathType* itk::PathToPathFilter< TInputPath, TOutputPath >::GetInput ( unsigned int idx )

◆ GetNameOfClass()

template<typename TInputPath, typename TOutputPath>

virtual const char* itk::PathToPathFilter< TInputPath, TOutputPath >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::PathSource< TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >, itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >, itk::PathToChainCodePathFilter< TInputPath, TOutputChainCodePath >, and itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >.

◆ New()

template<typename TInputPath, typename TOutputPath>

static Pointer itk::PathToPathFilter< TInputPath, TOutputPath >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputPath, typename TOutputPath>

void itk::PathToPathFilter< TInputPath, TOutputPath >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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

◆ SetInput() [1/2]

template<typename TInputPath, typename TOutputPath>

virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::SetInput ( const InputPathType * path )

virtual

◆ SetInput() [2/2]

template<typename TInputPath, typename TOutputPath>

virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::SetInput	(	unsigned int	,
		const TInputPath *	path
	)

virtual

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

itkPathToPathFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TInputPath, typename TOutputPath> class itk::PathToPathFilter< TInputPath, TOutputPath >

Member Typedef Documentation

◆ ConstPointer

◆ InputPathConstPointer

◆ InputPathPointer

◆ InputPathType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PathToPathFilter()

◆ ~PathToPathFilter()

Member Function Documentation

◆ CreateAnother()

◆ GenerateInputRequestedRegion()

◆ GetInput() [1/2]

◆ GetInput() [2/2]

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

template<typename TInputPath, typename TOutputPath>
class itk::PathToPathFilter< TInputPath, TOutputPath >