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

#include <itkPipelineMonitorImageFilter.h>

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

List of all members.

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

void ClearPipelineSavedInformation (void)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
RegionVectorType GetInputRequestedRegions (void) const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfUpdates (void) const
RegionVectorType GetOutputRequestedRegions (void) const
RegionVectorType GetUpdatedBufferedRegions (void) const
RegionVectorType GetUpdatedRequestedRegions (void) const
bool VerifyAllInputCanNotStream (void)
bool VerifyAllInputCanStream (int expectedNumber)
bool VerifyAllNoUpdate (void)
bool VerifyDownStreamFilterExecutedPropagation (void)
bool VerifyInputFilterBufferedRequestedRegions (void)
bool VerifyInputFilterExecutedStreaming (int expectedNumber)
bool VerifyInputFilterMatchedRequestedRegions (void)
bool VerifyInputFilterMatchedUpdateOutputInformation (void)
bool VerifyInputFilterRequestedLargestRegion (void)
virtual void SetClearPipelineOnGenerateOutputInformation (bool _arg)
virtual bool GetClearPipelineOnGenerateOutputInformation ()
virtual void ClearPipelineOnGenerateOutputInformationOn ()
virtual void ClearPipelineOnGenerateOutputInformationOff ()
virtual void GenerateOutputInformation (void)
virtual void PropagateRequestedRegion (DataObject *output)
virtual void EnlargeOutputRequestedRegion (DataObject *output)
virtual void GenerateInputRequestedRegion (void)
virtual void GenerateData (void)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

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

Detailed Description

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

Definition at line 65 of file itkPipelineMonitorImageFilter.h.


Member Typedef Documentation

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

Definition at line 76 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 80 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
typedef TImageType::ConstPointer itk::PipelineMonitorImageFilter< TImageType >::InputImageConstPointer
template<class TImageType >
typedef TImageType::Pointer itk::PipelineMonitorImageFilter< TImageType >::InputImagePointer
template<class TImageType >
typedef SmartPointer<Self> itk::PipelineMonitorImageFilter< TImageType >::Pointer
template<class TImageType >
typedef TImageType::PointType itk::PipelineMonitorImageFilter< TImageType >::PointType

Definition at line 75 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 82 of file itkPipelineMonitorImageFilter.h.

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

Standard class typedefs.

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

Definition at line 70 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 77 of file itkPipelineMonitorImageFilter.h.

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

Constructor & Destructor Documentation

template<class TImageType >
itk::PipelineMonitorImageFilter< TImageType >::PipelineMonitorImageFilter ( void  ) [protected]
template<class TImageType >
itk::PipelineMonitorImageFilter< TImageType >::PipelineMonitorImageFilter ( const PipelineMonitorImageFilter< TImageType > &  ) [private]

Member Function Documentation

template<class 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<class 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<class TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::ClearPipelineSavedInformation ( void  )

Clears all saved pipeline information, but increments NumberOfClearPipeline.

template<class TImageType >
virtual::itk::LightObject::Pointer itk::PipelineMonitorImageFilter< TImageType >::CreateAnother ( void  ) 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<class TImageType >
virtual void itk::PipelineMonitorImageFilter< TImageType >::EnlargeOutputRequestedRegion ( DataObject output) [virtual]

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

Reimplemented from itk::ProcessObject.

template<class TImageType >
virtual void itk::PipelineMonitorImageFilter< TImageType >::GenerateData ( void  ) [virtual]

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

Reimplemented from itk::ImageSource< TImageType >.

template<class TImageType >
virtual void itk::PipelineMonitorImageFilter< TImageType >::GenerateInputRequestedRegion ( void  ) [virtual]

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

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

template<class TImageType >
virtual void itk::PipelineMonitorImageFilter< TImageType >::GenerateOutputInformation ( void  ) [virtual]

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

Reimplemented from itk::ProcessObject.

template<class 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<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetInputRequestedRegions ( void  ) const [inline]
template<class TImageType >
virtual const char* itk::PipelineMonitorImageFilter< TImageType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

template<class TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::GetNumberOfUpdates ( void  ) const [inline]
template<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetOutputRequestedRegions ( void  ) const [inline]
template<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedBufferedRegions ( void  ) const [inline]
template<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::GetUpdatedRequestedRegions ( void  ) const [inline]
template<class TImageType >
static Pointer itk::PipelineMonitorImageFilter< TImageType >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::operator= ( const PipelineMonitorImageFilter< TImageType > &  ) [private]
template<class TImageType >
void itk::PipelineMonitorImageFilter< TImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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<class TImageType >
virtual void itk::PipelineMonitorImageFilter< TImageType >::PropagateRequestedRegion ( DataObject output) [virtual]

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

Reimplemented from itk::ProcessObject.

template<class 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<class TImageType >
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.

template<class 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<class TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyAllNoUpdate ( void  )

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

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

Verifies that the input filter buffered the requested region

template<class 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<class TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedRequestedRegions ( void  )
template<class TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterMatchedUpdateOutputInformation ( void  )

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

template<class TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::VerifyInputFilterRequestedLargestRegion ( void  )

Member Data Documentation

template<class TImageType >
bool itk::PipelineMonitorImageFilter< TImageType >::m_ClearPipelineOnGenerateOutputInformation [private]

Definition at line 184 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_InputRequestedRegions [private]
template<class TImageType >
unsigned int itk::PipelineMonitorImageFilter< TImageType >::m_NumberOfClearPipeline [private]

Definition at line 188 of file itkPipelineMonitorImageFilter.h.

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

Definition at line 196 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
ImageRegionType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputLargestPossibleRegion [private]

Definition at line 198 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
PointType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputOrigin [private]

Definition at line 195 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
SpacingType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedOutputSpacing [private]

Definition at line 197 of file itkPipelineMonitorImageFilter.h.

template<class TImageType >
RegionVectorType itk::PipelineMonitorImageFilter< TImageType >::m_UpdatedRequestedRegions [private]

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