ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::PipelineMonitorImageFilter< TImageType > Class Template Reference
Group Core » Module ITKTestKernel

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

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

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

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

void ClearPipelineSavedInformation ()
 
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
 
bool VerifyAllInputCanNotStream ()
 
bool VerifyAllInputCanStream (int expectedNumber)
 
bool VerifyAllNoUpdate ()
 
bool VerifyDownStreamFilterExecutedPropagation ()
 
bool VerifyInputFilterBufferedRequestedRegions ()
 
bool VerifyInputFilterExecutedStreaming (int expectedNumber)
 
bool VerifyInputFilterMatchedRequestedRegions ()
 
bool VerifyInputFilterMatchedUpdateOutputInformation ()
 
bool VerifyInputFilterRequestedLargestRegion ()
 
virtual void SetClearPipelineOnGenerateOutputInformation (bool _arg)
 
virtual bool GetClearPipelineOnGenerateOutputInformation ()
 
virtual void ClearPipelineOnGenerateOutputInformationOn ()
 
void GenerateOutputInformation () override
 
void PropagateRequestedRegion (DataObject *output) override
 
void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateInputRequestedRegion () override
 
void GenerateData () override
 
- Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
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 >
const char * GetNameOfClass () const override
 
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
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 AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
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 DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (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 CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
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 VerifyInputInformation () const
 
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 SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (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 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 >
 
- 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
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< TImageType >
bool m_DynamicMultiThreading
 
- 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

Member Function Documentation

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

◆ EnlargeOutputRequestedRegion()

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

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

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::GenerateData ( )
overridevirtual

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

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::GenerateInputRequestedRegion ( )
overridevirtual

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

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

Definition at line 173 of file itkPipelineMonitorImageFilter.h.

◆ GetNameOfClass()

template<typename TImageType >
const char * itk::PipelineMonitorImageFilter< TImageType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetNumberOfUpdates()

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

Definition at line 163 of file itkPipelineMonitorImageFilter.h.

◆ GetOutputRequestedRegions()

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetOutputRequestedRegions ( ) const
inline

Definition at line 168 of file itkPipelineMonitorImageFilter.h.

◆ GetUpdatedBufferedRegions()

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedBufferedRegions ( ) const
inline

Definition at line 178 of file itkPipelineMonitorImageFilter.h.

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ PropagateRequestedRegion()

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

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

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.

◆ VerifyInputFilterMatchedRequestedRegions()

template<typename TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedRequestedRegions ( )

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

Member Data Documentation

◆ m_ClearPipelineOnGenerateOutputInformation

template<typename TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::m_ClearPipelineOnGenerateOutputInformation {}
private

Definition at line 223 of file itkPipelineMonitorImageFilter.h.

◆ m_InputRequestedRegions

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_InputRequestedRegions {}
private

Definition at line 230 of file itkPipelineMonitorImageFilter.h.

◆ m_NumberOfClearPipeline

template<typename TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfClearPipeline {}
private

Definition at line 227 of file itkPipelineMonitorImageFilter.h.

◆ m_NumberOfUpdates

template<typename TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfUpdates {}
private

Definition at line 225 of file itkPipelineMonitorImageFilter.h.

◆ m_OutputRequestedRegions

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_OutputRequestedRegions {}
private

Definition at line 229 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedBufferedRegions

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedBufferedRegions {}
private

Definition at line 231 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedOutputDirection

template<typename TImageType >
DirectionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputDirection {}
private

Definition at line 235 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedOutputLargestPossibleRegion

template<typename TImageType >
ImageRegionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputLargestPossibleRegion {}
private

Definition at line 237 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedOutputOrigin

template<typename TImageType >
PointType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputOrigin {}
private

Definition at line 234 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedOutputSpacing

template<typename TImageType >
SpacingType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputSpacing {}
private

Definition at line 236 of file itkPipelineMonitorImageFilter.h.

◆ m_UpdatedRequestedRegions

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedRequestedRegions {}
private

Definition at line 232 of file itkPipelineMonitorImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3