ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkPipelineMonitorImageFilter.h>
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 67 of file itkPipelineMonitorImageFilter.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef TImageType::DirectionType | DirectionType |
typedef Superclass::InputImageRegionType | ImageRegionType |
typedef TImageType::ConstPointer | InputImageConstPointer |
typedef TImageType::Pointer | InputImagePointer |
typedef SmartPointer< Self > | Pointer |
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 Self > | ConstPointer |
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< Self > | Pointer |
typedef ImageToImageFilter | Self |
typedef ImageSource< TImageType > | Superclass |
Public Types inherited from itk::ImageSource< TImageType > | |
typedef SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
typedef ImageSource | Self |
typedef ProcessObject | Superclass |
Public Types inherited from itk::ProcessObject | |
typedef SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
typedef ProcessObject | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Static Public Member Functions | |
static Pointer | New () |
Private Member Functions | |
void | operator= (const PipelineMonitorImageFilter &) |
PipelineMonitorImageFilter (const PipelineMonitorImageFilter &) | |
Additional Inherited Members | |
Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType > | |
static const unsigned int | InputImageDimension |
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 ITK_THREAD_RETURN_TYPE | ThreaderCallback (void *arg) |
Protected Attributes inherited from itk::ProcessObject | |
TimeStamp | m_OutputInformationMTime |
bool | m_Updating |
typedef SmartPointer<const Self> itk::PipelineMonitorImageFilter< TImageType >::ConstPointer |
Definition at line 75 of file itkPipelineMonitorImageFilter.h.
typedef TImageType::DirectionType itk::PipelineMonitorImageFilter< TImageType >::DirectionType |
Definition at line 78 of file itkPipelineMonitorImageFilter.h.
typedef Superclass::InputImageRegionType itk::PipelineMonitorImageFilter< TImageType >::ImageRegionType |
Definition at line 82 of file itkPipelineMonitorImageFilter.h.
typedef TImageType::ConstPointer itk::PipelineMonitorImageFilter< TImageType >::InputImageConstPointer |
Definition at line 81 of file itkPipelineMonitorImageFilter.h.
typedef TImageType::Pointer itk::PipelineMonitorImageFilter< TImageType >::InputImagePointer |
Definition at line 80 of file itkPipelineMonitorImageFilter.h.
typedef SmartPointer<Self> itk::PipelineMonitorImageFilter< TImageType >::Pointer |
Definition at line 74 of file itkPipelineMonitorImageFilter.h.
typedef TImageType::PointType itk::PipelineMonitorImageFilter< TImageType >::PointType |
Definition at line 77 of file itkPipelineMonitorImageFilter.h.
typedef std::vector<typename TImageType::RegionType> itk::PipelineMonitorImageFilter< TImageType >::RegionVectorType |
Definition at line 84 of file itkPipelineMonitorImageFilter.h.
typedef PipelineMonitorImageFilter itk::PipelineMonitorImageFilter< TImageType >::Self |
Definition at line 72 of file itkPipelineMonitorImageFilter.h.
typedef TImageType::SpacingType itk::PipelineMonitorImageFilter< TImageType >::SpacingType |
Definition at line 79 of file itkPipelineMonitorImageFilter.h.
typedef ImageToImageFilter<TImageType, TImageType> itk::PipelineMonitorImageFilter< TImageType >::Superclass |
Definition at line 73 of file itkPipelineMonitorImageFilter.h.
|
protected |
|
private |
|
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
|
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
void itk::PipelineMonitorImageFilter< TImageType >::ClearPipelineSavedInformation | ( | void | ) |
Clears all saved pipeline information, but increments NumberOfClearPipeline.
|
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.
|
virtual |
Standard pipeline methods are overloaded to call superclass's implementation and record information.
Reimplemented from itk::ProcessObject.
|
virtual |
Standard pipeline methods are overloaded to call superclass's implementation and record information.
Reimplemented from itk::ImageSource< TImageType >.
|
virtual |
Standard pipeline methods are overloaded to call superclass's implementation and record information.
Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.
|
virtual |
Standard pipeline methods are overloaded to call superclass's implementation and record information.
Reimplemented from itk::ProcessObject.
|
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
|
inline |
Definition at line 154 of file itkPipelineMonitorImageFilter.h.
References itk::PipelineMonitorImageFilter< TImageType >::m_InputRequestedRegions.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.
|
inline |
Definition at line 152 of file itkPipelineMonitorImageFilter.h.
References itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfUpdates.
|
inline |
Definition at line 153 of file itkPipelineMonitorImageFilter.h.
References itk::PipelineMonitorImageFilter< TImageType >::m_OutputRequestedRegions.
|
inline |
Definition at line 155 of file itkPipelineMonitorImageFilter.h.
References itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedBufferedRegions.
|
inline |
Definition at line 156 of file itkPipelineMonitorImageFilter.h.
References itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedRequestedRegions.
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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 >.
|
virtual |
Standard pipeline methods are overloaded to call superclass's implementation and record information.
Reimplemented from itk::ProcessObject.
|
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
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllInputCanNotStream | ( | void | ) |
Checks that the input filter didn't stream, and just updated the largest possible region along with other correct behaviors.
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.
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllNoUpdate | ( | void | ) |
This method verifies that propagation was executed yet no updating was needed.
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyDownStreamFilterExecutedPropagation | ( | void | ) |
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterBufferedRequestedRegions | ( | void | ) |
Verifies that the input filter buffered the requested region
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.
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedRequestedRegions | ( | void | ) |
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedUpdateOutputInformation | ( | void | ) |
Verifies that the output information didn't change between the GenerateOutputInformation and the UpdateData phases of the pipeline.
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterRequestedLargestRegion | ( | void | ) |
|
private |
Definition at line 186 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 193 of file itkPipelineMonitorImageFilter.h.
Referenced by itk::PipelineMonitorImageFilter< TImageType >::GetInputRequestedRegions().
|
private |
Definition at line 190 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 188 of file itkPipelineMonitorImageFilter.h.
Referenced by itk::PipelineMonitorImageFilter< TImageType >::GetNumberOfUpdates().
|
private |
Definition at line 192 of file itkPipelineMonitorImageFilter.h.
Referenced by itk::PipelineMonitorImageFilter< TImageType >::GetOutputRequestedRegions().
|
private |
Definition at line 194 of file itkPipelineMonitorImageFilter.h.
Referenced by itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedBufferedRegions().
|
private |
Definition at line 198 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 200 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 197 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 199 of file itkPipelineMonitorImageFilter.h.
|
private |
Definition at line 195 of file itkPipelineMonitorImageFilter.h.
Referenced by itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedRequestedRegions().