itk::PipelineMonitorImageFilter< TImageType > Class Template Reference

#include <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 = SmartPointer< const Self >
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = TImageType
using	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	Pointer = SmartPointer< Self >
using	Self = ImageToImageFilter
using	Superclass = ImageSource< TImageType >
Public Types inherited from itk::ImageSource< TImageType >
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 = TImageType
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 ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TImageType *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TImageType >
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftOutput (DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
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 ()
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	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::ImageToImageFilter< TImageType, TImageType >
static void	SetGlobalDefaultDirectionTolerance (double)
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static double	GetGlobalDefaultCoordinateTolerance ()
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 ()
bool	m_ClearPipelineOnGenerateOutputInformation
unsigned int	m_NumberOfUpdates
unsigned int	m_NumberOfClearPipeline
RegionVectorType	m_OutputRequestedRegions
RegionVectorType	m_InputRequestedRegions
RegionVectorType	m_UpdatedBufferedRegions
RegionVectorType	m_UpdatedRequestedRegions
PointType	m_UpdatedOutputOrigin
DirectionType	m_UpdatedOutputDirection
SpacingType	m_UpdatedOutputSpacing
ImageRegionType	m_UpdatedOutputLargestPossibleRegion
virtual void	SetClearPipelineOnGenerateOutputInformation (bool _arg)
virtual bool	GetClearPipelineOnGenerateOutputInformation ()
virtual void	ClearPipelineOnGenerateOutputInformationOn ()
virtual void	ClearPipelineOnGenerateOutputInformationOff ()
bool	VerifyAllInputCanStream (int expectedNumber)
bool	VerifyAllInputCanNotStream ()
bool	VerifyAllNoUpdate ()
bool	VerifyDownStreamFilterExecutedPropagation ()
bool	VerifyInputFilterExecutedStreaming (int expectedNumber)
bool	VerifyInputFilterMatchedUpdateOutputInformation ()
bool	VerifyInputFilterBufferedRequestedRegions ()
bool	VerifyInputFilterMatchedRequestedRegions ()
bool	VerifyInputFilterRequestedLargestRegion ()
unsigned int	GetNumberOfUpdates () const
RegionVectorType	GetOutputRequestedRegions () const
RegionVectorType	GetInputRequestedRegions () const
RegionVectorType	GetUpdatedBufferedRegions () const
RegionVectorType	GetUpdatedRequestedRegions () const
virtual PointType	GetUpdatedOutputOrigin () const
virtual DirectionType	GetUpdatedOutputDirection () const
virtual SpacingType	GetUpdatedOutputSpacing () const
virtual ImageRegionType	GetUpdatedOutputLargestPossibleRegion () const
void	ClearPipelineSavedInformation ()
void	GenerateOutputInformation () override
void	PropagateRequestedRegion (DataObject *output) override
void	EnlargeOutputRequestedRegion (DataObject *output) override
void	GenerateInputRequestedRegion () override
void	GenerateData () override
	PipelineMonitorImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType >
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< TImageType >
static constexpr unsigned int	OutputImageDimension
Protected Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
	ImageToImageFilter ()
	~ImageToImageFilter () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_CONST override
void	GenerateInputRequestedRegion () override
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
Protected Member Functions inherited from itk::ImageSource< TImageType >
	ImageSource ()
	~ImageSource () override=default
void	GenerateData () override
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	AfterThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
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	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	GenerateOutputRequestedRegion (DataObject *output)
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 ()
Static Protected Member Functions inherited from itk::ImageSource< TImageType >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
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::ImageSource< TImageType >
bool	m_DynamicMultiThreading
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 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.

Examples

SphinxExamples/src/Core/Common/StreamAPipeline/Code.cxx.

Definition at line 68 of file itkPipelineMonitorImageFilter.h.

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

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

Member Function Documentation

ClearPipelineOnGenerateOutputInformationOff()

template<typename TImageType >

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

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

ClearPipelineOnGenerateOutputInformationOn()

template<typename TImageType >

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

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

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

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

Reimplemented from itk::ProcessObject.

GenerateData()

template<typename TImageType >

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

overridevirtual

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

Reimplemented from itk::ProcessObject.

GenerateInputRequestedRegion()

template<typename TImageType >

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

overridevirtual

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

Reimplemented from itk::ProcessObject.

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

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

GetInputRequestedRegions()

template<typename TImageType >

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

inline

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

Definition at line 173 of file itkPipelineMonitorImageFilter.h.

GetNameOfClass()

template<typename TImageType >

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

virtual

Run-time type information (and related methods).

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

GetNumberOfUpdates()

template<typename TImageType >

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

inline

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

Definition at line 163 of file itkPipelineMonitorImageFilter.h.

GetOutputRequestedRegions()

template<typename TImageType >

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

inline

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

Definition at line 168 of file itkPipelineMonitorImageFilter.h.

GetUpdatedBufferedRegions()

template<typename TImageType >

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

inline

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

Definition at line 178 of file itkPipelineMonitorImageFilter.h.

GetUpdatedOutputDirection()

template<typename TImageType >

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

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

GetUpdatedOutputLargestPossibleRegion()

template<typename TImageType >

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

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

GetUpdatedOutputOrigin()

template<typename TImageType >

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

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

GetUpdatedOutputSpacing()

template<typename TImageType >

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

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

GetUpdatedRequestedRegions()

template<typename TImageType >

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

inline

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

Definition at line 183 of file itkPipelineMonitorImageFilter.h.

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

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

Reimplemented from itk::ProcessObject.

PropagateRequestedRegion()

template<typename TImageType >

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

overridevirtual

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

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

(

)

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

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 the GenerateData executed the expected number of times.

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

VerifyInputFilterMatchedRequestedRegions()

template<typename TImageType >

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedRequestedRegions

(

)

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

VerifyInputFilterMatchedUpdateOutputInformation()

template<typename TImageType >

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedUpdateOutputInformation

(

)

Verifies that the output information didn't change between the GenerateOutputInformation and the UpdateData phases of the pipeline.

VerifyInputFilterRequestedLargestRegion()

template<typename TImageType >

bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterRequestedLargestRegion

(

)

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

Member Data Documentation

m_ClearPipelineOnGenerateOutputInformation

template<typename TImageType >

bool itk::PipelineMonitorImageFilter< TImageType >::m_ClearPipelineOnGenerateOutputInformation

private

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

Definition at line 223 of file itkPipelineMonitorImageFilter.h.

m_InputRequestedRegions

template<typename TImageType >

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_InputRequestedRegions

private

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

Definition at line 230 of file itkPipelineMonitorImageFilter.h.

m_NumberOfClearPipeline

template<typename TImageType >

unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfClearPipeline

private

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

Definition at line 227 of file itkPipelineMonitorImageFilter.h.

m_NumberOfUpdates

template<typename TImageType >

unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfUpdates

private

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

Definition at line 225 of file itkPipelineMonitorImageFilter.h.

m_OutputRequestedRegions

template<typename TImageType >

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_OutputRequestedRegions

private

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

Definition at line 229 of file itkPipelineMonitorImageFilter.h.

m_UpdatedBufferedRegions

template<typename TImageType >

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedBufferedRegions

private

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

Definition at line 231 of file itkPipelineMonitorImageFilter.h.

m_UpdatedOutputDirection

template<typename TImageType >

DirectionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputDirection

private

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

Definition at line 235 of file itkPipelineMonitorImageFilter.h.

m_UpdatedOutputLargestPossibleRegion

template<typename TImageType >

ImageRegionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputLargestPossibleRegion

private

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

Definition at line 237 of file itkPipelineMonitorImageFilter.h.

m_UpdatedOutputOrigin

template<typename TImageType >

PointType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputOrigin

private

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

Definition at line 234 of file itkPipelineMonitorImageFilter.h.

m_UpdatedOutputSpacing

template<typename TImageType >

SpacingType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputSpacing

private

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

Definition at line 236 of file itkPipelineMonitorImageFilter.h.

m_UpdatedRequestedRegions

template<typename TImageType >

RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedRequestedRegions

private

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

Definition at line 232 of file itkPipelineMonitorImageFilter.h.

---

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

• itkPipelineMonitorImageFilter.h