ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::PipelineMonitorImageFilter< TImageType > Class Template Reference

#include <itkPipelineMonitorImageFilter.h>

+ Inheritance diagram for itk::PipelineMonitorImageFilter< TImageType >:
+ Collaboration diagram for itk::PipelineMonitorImageFilter< TImageType >:

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.

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

Definition at line 67 of file itkPipelineMonitorImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TImageType::DirectionType DirectionType
 
typedef
Superclass::InputImageRegionType 
ImageRegionType
 
typedef TImageType::ConstPointer InputImageConstPointer
 
typedef TImageType::Pointer InputImagePointer
 
typedef SmartPointer< SelfPointer
 
typedef TImageType::PointType PointType
 
typedef std::vector< typename
TImageType::RegionType > 
RegionVectorType
 
typedef PipelineMonitorImageFilter Self
 
typedef TImageType::SpacingType SpacingType
 
typedef ImageToImageFilter
< TImageType, TImageType > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TImageType InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TImageType > Superclass
 
- Public Types inherited from itk::ImageSource< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void ClearPipelineSavedInformation ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
RegionVectorType GetInputRequestedRegions (void) const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfUpdates (void) const
 
RegionVectorType GetOutputRequestedRegions (void) const
 
RegionVectorType GetUpdatedBufferedRegions (void) const
 
virtual DirectionType GetUpdatedOutputDirection () const
 
virtual ImageRegionType GetUpdatedOutputLargestPossibleRegion () const
 
virtual PointType GetUpdatedOutputOrigin () const
 
virtual SpacingType GetUpdatedOutputSpacing () const
 
RegionVectorType GetUpdatedRequestedRegions (void) 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 ()
 
virtual void ClearPipelineOnGenerateOutputInformationOff ()
 
virtual void GenerateOutputInformation () override
 
virtual void PropagateRequestedRegion (DataObject *output) override
 
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateInputRequestedRegion (void) override
 
virtual void GenerateData (void) override
 
- Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
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 >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
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 ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 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)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const PipelineMonitorImageFilter &)
 
 PipelineMonitorImageFilter (const PipelineMonitorImageFilter &)
 

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 const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TImageType >
static const unsigned int OutputImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TImageType >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TImageType >
typedef SmartPointer<const Self> itk::PipelineMonitorImageFilter< TImageType >::ConstPointer

Definition at line 75 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef TImageType::DirectionType itk::PipelineMonitorImageFilter< TImageType >::DirectionType

Definition at line 78 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef Superclass::InputImageRegionType itk::PipelineMonitorImageFilter< TImageType >::ImageRegionType

Definition at line 82 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef TImageType::ConstPointer itk::PipelineMonitorImageFilter< TImageType >::InputImageConstPointer

Definition at line 81 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef TImageType::Pointer itk::PipelineMonitorImageFilter< TImageType >::InputImagePointer

Definition at line 80 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef SmartPointer<Self> itk::PipelineMonitorImageFilter< TImageType >::Pointer

Definition at line 74 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef TImageType::PointType itk::PipelineMonitorImageFilter< TImageType >::PointType

Definition at line 77 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef std::vector<typename TImageType::RegionType> itk::PipelineMonitorImageFilter< TImageType >::RegionVectorType

Definition at line 84 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef PipelineMonitorImageFilter itk::PipelineMonitorImageFilter< TImageType >::Self

Definition at line 72 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef TImageType::SpacingType itk::PipelineMonitorImageFilter< TImageType >::SpacingType

Definition at line 79 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
typedef ImageToImageFilter<TImageType, TImageType> itk::PipelineMonitorImageFilter< TImageType >::Superclass

Definition at line 73 of file itkPipelineMonitorImageFilter.h.

Constructor & Destructor Documentation

template<typename TImageType >
itk::PipelineMonitorImageFilter< TImageType >::PipelineMonitorImageFilter ( )
protected
template<typename TImageType >
itk::PipelineMonitorImageFilter< TImageType >::PipelineMonitorImageFilter ( const PipelineMonitorImageFilter< TImageType > &  )
private

Member Function Documentation

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

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

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

Clears all saved pipeline information, but increments NumberOfClearPipeline.

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.

template<typename TImageType >
virtual 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.

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

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

Reimplemented from itk::ImageSource< TImageType >.

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

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

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

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

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

Reimplemented from itk::ProcessObject.

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

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetInputRequestedRegions ( void  ) const
inline
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 >.

template<typename TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::GetNumberOfUpdates ( void  ) const
inline
template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetOutputRequestedRegions ( void  ) const
inline
template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedBufferedRegions ( void  ) const
inline
template<typename TImageType >
virtual DirectionType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputDirection ( ) const
virtual
template<typename TImageType >
virtual ImageRegionType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputLargestPossibleRegion ( ) const
virtual
template<typename TImageType >
virtual PointType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputOrigin ( ) const
virtual
template<typename TImageType >
virtual SpacingType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedOutputSpacing ( ) const
virtual
template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedRequestedRegions ( void  ) const
inline
template<typename TImageType >
static Pointer itk::PipelineMonitorImageFilter< TImageType >::New ( )
static

Method for creation through the object factory.

template<typename TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::operator= ( const PipelineMonitorImageFilter< TImageType > &  )
private
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 >.

template<typename TImageType >
virtual 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.

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

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.

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.

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

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

template<typename TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyDownStreamFilterExecutedPropagation ( )
template<typename TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterBufferedRequestedRegions ( )

Verifies that the input filter buffered the requested region

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.

template<typename TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedRequestedRegions ( )
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.

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

Member Data Documentation

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

Definition at line 190 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_InputRequestedRegions
private
template<typename TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfClearPipeline
private

Definition at line 194 of file itkPipelineMonitorImageFilter.h.

template<typename TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfUpdates
private
template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_OutputRequestedRegions
private
template<typename TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedBufferedRegions
private
template<typename TImageType >
DirectionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputDirection
private

Definition at line 202 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 204 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 201 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 203 of file itkPipelineMonitorImageFilter.h.

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

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