#include <itkPipelineMonitorImageFilter.h>

Detailed Description

template<typename TImageType>
class itk::PipelineMonitorImageFilter< TImageType >

Enables monitoring, recording and debugging of the pipeline execution and information exchange.

This filter is useful for testing, debugging, and understanding the pipeline. When DebugOn is enabled and compiled in Debug mode, many itkDebug messages are printed. This filter also features, several Verify methods which check the recorded information, for certain conditions, which should occur when well behaved filters are executed.

There are two meta verify methods that should primarily be used depending on the expected capabilities of the pipeline:

VerifyAllInputCanStream
VerifyAllInputCanNotStream

During the pipeline execution this filter records a variety of information to aid if verifying correct pipeline behavior:

NumberOfUpdate the number of times GenerateData was executed
OutputRequestedRegions an array of the output of this filter's requested region
InputRequestedRegions an array of the input image's requested region after PropagateRequestedRegion
UpdatedBufferedRegions an array of the input image's buffered region after upstream GenerateData
UpdatedRequestedRegions an array of the input image's requested region after upstream GenerateData

The following are recorded from the input image after the input's output information is generated:

UpdatedOutputOrigin
UpdatedOutputDirection
UpdatedOutputSpacing
UpdatedOutputLargestPossibleRegion

This filter always runs in-place so it has no per-pixel overhead.

Definition at line 68 of file itkPipelineMonitorImageFilter.h.

Inheritance diagram for itk::PipelineMonitorImageFilter< TImageType >:

Collaboration diagram for itk::PipelineMonitorImageFilter< TImageType >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	DirectionType = typename TImageType::DirectionType

using	ImageRegionType = typename Superclass::InputImageRegionType

using	InputImageConstPointer = typename TImageType::ConstPointer

using	InputImagePointer = typename TImageType::Pointer

using	Pointer = SmartPointer<Self>

using	PointType = typename TImageType::PointType

using	RegionVectorType = std::vector<typename TImageType::RegionType>

using	Self = PipelineMonitorImageFilter

using	SpacingType = typename TImageType::SpacingType

using	Superclass = ImageToImageFilter<TImageType, TImageType>

Public Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

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

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = ImageSource

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
virtual void	ClearPipelineOnGenerateOutputInformationOff ()

virtual void	ClearPipelineOnGenerateOutputInformationOn ()

void	ClearPipelineSavedInformation ()

virtual::itk::LightObject::Pointer	CreateAnother () const

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

virtual bool	GetClearPipelineOnGenerateOutputInformation ()

RegionVectorType	GetInputRequestedRegions () const

const char *	GetNameOfClass () const override

unsigned int	GetNumberOfUpdates () const

RegionVectorType	GetOutputRequestedRegions () const

RegionVectorType	GetUpdatedBufferedRegions () const

virtual DirectionType	GetUpdatedOutputDirection () const

virtual ImageRegionType	GetUpdatedOutputLargestPossibleRegion () const

virtual PointType	GetUpdatedOutputOrigin () const

virtual SpacingType	GetUpdatedOutputSpacing () const

RegionVectorType	GetUpdatedRequestedRegions () const

void	PropagateRequestedRegion (DataObject *output) override

virtual void	SetClearPipelineOnGenerateOutputInformation (bool _arg)

bool	VerifyAllInputCanNotStream ()

bool	VerifyAllInputCanStream (int expectedNumber)

bool	VerifyAllNoUpdate ()

bool	VerifyDownStreamFilterExecutedPropagation ()

bool	VerifyInputFilterBufferedRequestedRegions ()

bool	VerifyInputFilterExecutedStreaming (int expectedNumber)

bool	VerifyInputFilterMatchedRequestedRegions ()

bool	VerifyInputFilterMatchedUpdateOutputInformation ()

bool	VerifyInputFilterRequestedLargestRegion ()

Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageType *	GetInput () const

const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopBackInput () override

void	PopFrontInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TImageType *image)

virtual void	SetInput (unsigned int, const TImageType *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	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)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

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

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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) const

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::ImageToImageFilter< TImageType, TImageType >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

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

Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

	ImageToImageFilter ()

void	VerifyInputInformation () const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

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

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

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
bool	m_ClearPipelineOnGenerateOutputInformation {}

RegionVectorType	m_InputRequestedRegions {}

unsigned int	m_NumberOfClearPipeline {}

unsigned int	m_NumberOfUpdates {}

RegionVectorType	m_OutputRequestedRegions {}

RegionVectorType	m_UpdatedBufferedRegions {}

DirectionType	m_UpdatedOutputDirection {}

ImageRegionType	m_UpdatedOutputLargestPossibleRegion {}

PointType	m_UpdatedOutputOrigin {}

SpacingType	m_UpdatedOutputSpacing {}

RegionVectorType	m_UpdatedRequestedRegions {}

Additional Inherited Members
Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

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

using itk::PipelineMonitorImageFilter< TImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 76 of file itkPipelineMonitorImageFilter.h.

◆ DirectionType

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::DirectionType = typename TImageType::DirectionType

Definition at line 79 of file itkPipelineMonitorImageFilter.h.

◆ ImageRegionType

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::ImageRegionType = typename Superclass::InputImageRegionType

Definition at line 83 of file itkPipelineMonitorImageFilter.h.

◆ InputImageConstPointer

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::InputImageConstPointer = typename TImageType::ConstPointer

Definition at line 82 of file itkPipelineMonitorImageFilter.h.

◆ InputImagePointer

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::InputImagePointer = typename TImageType::Pointer

Definition at line 81 of file itkPipelineMonitorImageFilter.h.

◆ Pointer

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::Pointer = SmartPointer<Self>

Definition at line 75 of file itkPipelineMonitorImageFilter.h.

◆ PointType

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::PointType = typename TImageType::PointType

Definition at line 78 of file itkPipelineMonitorImageFilter.h.

◆ RegionVectorType

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::RegionVectorType = std::vector<typename TImageType::RegionType>

Definition at line 85 of file itkPipelineMonitorImageFilter.h.

◆ Self

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::Self = PipelineMonitorImageFilter

Definition at line 73 of file itkPipelineMonitorImageFilter.h.

◆ SpacingType

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::SpacingType = typename TImageType::SpacingType

Definition at line 80 of file itkPipelineMonitorImageFilter.h.

◆ Superclass

template<typename TImageType>

using itk::PipelineMonitorImageFilter< TImageType >::Superclass = ImageToImageFilter<TImageType, TImageType>

Definition at line 74 of file itkPipelineMonitorImageFilter.h.

Constructor & Destructor Documentation

◆ PipelineMonitorImageFilter()

template<typename TImageType>

itk::PipelineMonitorImageFilter< TImageType >::PipelineMonitorImageFilter ( )

protected

Referenced by GetNameOfClass().

Member Function Documentation

◆ ClearPipelineOnGenerateOutputInformationOff()

template<typename TImageType>

virtual void itk::PipelineMonitorImageFilter< TImageType >::ClearPipelineOnGenerateOutputInformationOff ( )

virtual

◆ ClearPipelineOnGenerateOutputInformationOn()

template<typename TImageType>

virtual void itk::PipelineMonitorImageFilter< TImageType >::ClearPipelineOnGenerateOutputInformationOn ( )

virtual

◆ ClearPipelineSavedInformation()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::ClearPipelineSavedInformation ( )

Clears all saved pipeline information, but increments NumberOfClearPipeline.

◆ CreateAnother()

template<typename TImageType>

virtual::itk::LightObject::Pointer itk::PipelineMonitorImageFilter< TImageType >::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.

◆ EnlargeOutputRequestedRegion()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::EnlargeOutputRequestedRegion ( DataObject * output )

overridevirtual

Give the process object a chance to indicate 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.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::GenerateData ( )

overridevirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::GenerateInputRequestedRegion ( )

overridevirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.

◆ GenerateOutputInformation()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::GenerateOutputInformation ( )

overridevirtual

Standard pipeline methods are overloaded to call superclass's implementation and record information.

Reimplemented from itk::ProcessObject.

◆ GetClearPipelineOnGenerateOutputInformation()

template<typename TImageType>

virtual bool itk::PipelineMonitorImageFilter< TImageType >::GetClearPipelineOnGenerateOutputInformation ( )

virtual

◆ GetInputRequestedRegions()

template<typename TImageType>

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetInputRequestedRegions ( ) const

inline

Definition at line 172 of file itkPipelineMonitorImageFilter.h.

References m_InputRequestedRegions.

◆ GetNameOfClass()

template<typename TImageType>

const char * itk::PipelineMonitorImageFilter< TImageType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.

References PipelineMonitorImageFilter().

◆ GetNumberOfUpdates()

template<typename TImageType>

unsigned int itk::PipelineMonitorImageFilter< TImageType >::GetNumberOfUpdates ( ) const

inline

Definition at line 162 of file itkPipelineMonitorImageFilter.h.

References m_NumberOfUpdates.

◆ GetOutputRequestedRegions()

template<typename TImageType>

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetOutputRequestedRegions ( ) const

inline

Definition at line 167 of file itkPipelineMonitorImageFilter.h.

References m_OutputRequestedRegions.

◆ GetUpdatedBufferedRegions()

template<typename TImageType>

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedBufferedRegions ( ) const

inline

Definition at line 177 of file itkPipelineMonitorImageFilter.h.

References m_UpdatedBufferedRegions.

◆ GetUpdatedOutputDirection()

template<typename TImageType>

virtual DirectionType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputDirection ( ) const

virtual

◆ GetUpdatedOutputLargestPossibleRegion()

template<typename TImageType>

virtual ImageRegionType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputLargestPossibleRegion ( ) const

virtual

◆ GetUpdatedOutputOrigin()

template<typename TImageType>

virtual PointType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputOrigin ( ) const

virtual

◆ GetUpdatedOutputSpacing()

template<typename TImageType>

virtual SpacingType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputSpacing ( ) const

virtual

◆ GetUpdatedRequestedRegions()

template<typename TImageType>

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedRequestedRegions ( ) const

inline

Definition at line 182 of file itkPipelineMonitorImageFilter.h.

References m_UpdatedRequestedRegions.

◆ New()

template<typename TImageType>

static Pointer itk::PipelineMonitorImageFilter< TImageType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::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::ImageToImageFilter< TImageType, TImageType >.

◆ PropagateRequestedRegion()

template<typename TImageType>

void itk::PipelineMonitorImageFilter< TImageType >::PropagateRequestedRegion ( DataObject * output )

overridevirtual

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

Reimplemented from itk::ProcessObject.

◆ SetClearPipelineOnGenerateOutputInformation()

template<typename TImageType>

virtual void itk::PipelineMonitorImageFilter< TImageType >::SetClearPipelineOnGenerateOutputInformation ( bool _arg )

virtual

Enable/Disable clearing all saved pipeline information when GenerateOutputInformation is called.

The NumberOfClearPipelines is incremented, to aid in detection of certain pipeline errors caused but excessive execution of GenerateOutputInformation.

Defaults to On

◆ VerifyAllInputCanNotStream()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllInputCanNotStream ( )

Checks that the input filter didn't stream, and just updated the largest possible region along with other correct behaviors.

◆ VerifyAllInputCanStream()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllInputCanStream ( int expectedNumber )

This a meta verify method to check expected pipeline execution when the pipeline is capable of streaming. See VerifyInputFilterExecutedStreaming for information on the expectedNumber parameter.

◆ VerifyAllNoUpdate()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllNoUpdate ( )

This method verifies that propagation was executed yet no updating was needed.

◆ VerifyDownStreamFilterExecutedPropagation()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyDownStreamFilterExecutedPropagation ( )

◆ VerifyInputFilterBufferedRequestedRegions()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterBufferedRequestedRegions ( )

Verifies that the input filter buffered the requested region

◆ VerifyInputFilterExecutedStreaming()

template<typename TImageType>

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterExecutedStreaming ( int expectedNumber )

Verifies the GenerateData executed the expected number of times.

If expectedNumber is positive then the number of updates must match. If expectedNumber is negative then the number of updates must at least be |expectedNumber|. If expectedNumber is zero, then this method always returns true, and no verification is performed.