itk::LightProcessObject Class Reference

#include <itkLightProcessObject.h>

Inheritance diagram for itk::LightProcessObject:

Collaboration diagram for itk::LightProcessObject:

Detailed Description

LightProcessObject is the base class for all process objects (source, filters, mappers) in the Insight data processing pipeline.

LightProcessObject is an abstract object that specifies behavior and interface of visualization network process objects (sources, filters, mappers). Source objects are creators of visualization data; filters input, process, and output visualization data; and mappers transform data into another form (like rendering primitives or write data to a file).

A major role of LightProcessObject is to define the inputs and outputs of a filter. More than one input and/or output may exist for a given filter. Some classes (e.g., source objects or mapper objects) will not use inputs (the source) or outputs (mappers). In this case, the inputs or outputs is just ignored.

LightProcessObject invokes the following events: , Command::StartEvent, Command::EndEvent These are convenience events you can use for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.) See Command and LightObject for information on using AddObserver.

Another event Command::ProgressEvent can be observed. Some filters invoke this event periodically during their execution (with the progress, parameter, the fraction of work done). The use is similar to that of StartEvent and EndEvent. Filters may also check their AbortGenerateData flag to determine whether to prematurally end their execution.

An important feature of subclasses of LightProcessObject is that it is possible to control the memory-management model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text).

Subclasses of LightProcessObject may override 4 of the methods of this class to control how a given filter may interact with the pipeline (dataflow). These methods are: GenerateOutputInformation(), EnlargeOutputRequestedRegion(), GenerateInputRequestedRegion(), and GenerateOutputRequestedRegion(). By overriding these methods, a filter can deviate from the base assumptions of the pipeline execution model.

Definition at line 72 of file itkLightProcessObject.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightProcessObject	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

Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const bool &	GetAbortGenerateData () const
virtual const char *	GetNameOfClass () const
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress () 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
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
virtual void	GenerateData ()
	LightProcessObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~LightProcessObject ()
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
	LightProcessObject (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_AbortGenerateData
float	m_Progress

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::LightProcessObject::ConstPointer

Definition at line 79 of file itkLightProcessObject.h.

typedef SmartPointer< Self > itk::LightProcessObject::Pointer

Definition at line 78 of file itkLightProcessObject.h.

typedef LightProcessObject itk::LightProcessObject::Self

Standard class typedefs.

Definition at line 76 of file itkLightProcessObject.h.

typedef Object itk::LightProcessObject::Superclass

Definition at line 77 of file itkLightProcessObject.h.

Constructor & Destructor Documentation

itk::LightProcessObject::LightProcessObject ( )

protected

itk::LightProcessObject::~LightProcessObject ( )

protected

itk::LightProcessObject::LightProcessObject ( const Self &  )

private

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( )

virtual

virtual void itk::LightProcessObject::AbortGenerateDataOn ( )

virtual

Turn on and off the AbortGenerateData flag.

virtual::itk::LightObject::Pointer itk::LightProcessObject::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.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::HDF5TransformIOTemplate< TParametersValueType >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::GDCMImageIO, itk::HDF5ImageIO, itk::SCIFIOImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::CSVArray2DFileReader< TData >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::StimulateImageIO, itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >, itk::IPLCommonImageIO, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::MRCImageIO, itk::AnalyzeObjectLabelMapImageIO, itk::GE4ImageIO, itk::VTKImageIO, itk::GE5ImageIO, itk::BioRadImageIO, itk::VTKPolyDataMeshIO, itk::SiemensVisionImageIO, itk::VoxBoCUBImageIO, itk::GiftiMeshIO, itk::GEAdwImageIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::JPEG2000ImageIO, itk::VXLVideoIO, itk::RawImageIO< TPixel, VImageDimension >, itk::LSMImageIO, itk::TransformFileWriterTemplate< TParametersValueType >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::TransformFileReaderTemplate< TParametersValueType >, itk::PolygonGroupSpatialObjectXMLFileReader, itk::TIFFImageIO, itk::NiftiImageIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::MetaImageIO, itk::DCMTKTransformIO< TInternalComputationValueType >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::BMPImageIO, itk::GiplImageIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, itk::STLMeshIO, itk::DCMTKImageIO, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::OBJMeshIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::MGHImageIO, itk::NrrdImageIO, itk::MatlabTransformIOTemplate< ParametersValueType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::JPEGImageIO, itk::PNGImageIO, itk::TxtTransformIOTemplate< TParametersValueType >, itk::MetaArrayWriter, itk::MetaArrayReader, and itk::FDFImageIO.

virtual void itk::LightProcessObject::GenerateData ( void  )

inlineprotectedvirtual

This method causes the filter to generate its output.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, and itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >.

Definition at line 124 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) const

virtual

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

virtual const char* itk::LightProcessObject::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::GDCMImageIO, itk::HDF5ImageIO, itk::HDF5TransformIOTemplate< TParametersValueType >, itk::MeshIOBase, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::SCIFIOImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::CSVArray2DFileReader< TData >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageIOBase, itk::StimulateImageIO, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::IPLCommonImageIO, itk::CSVFileReaderBase, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::MRCImageIO, itk::AnalyzeObjectLabelMapImageIO, itk::GE4ImageIO, itk::VideoIOBase, itk::VTKImageIO, itk::GE5ImageIO, itk::BioRadImageIO, itk::VTKPolyDataMeshIO, itk::SiemensVisionImageIO, itk::VoxBoCUBImageIO, itk::StreamingImageIOBase, itk::GiftiMeshIO, itk::GEAdwImageIO, itk::JPEG2000ImageIO, itk::VXLVideoIO, itk::RawImageIO< TPixel, VImageDimension >, itk::LSMImageIO, itk::TransformFileWriterTemplate< TParametersValueType >, itk::TransformFileReaderTemplate< TParametersValueType >, itk::TIFFImageIO, itk::TransformIOBaseTemplate< TParametersValueType >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::TransformIOBaseTemplate< ParametersValueType >, itk::TransformIOBaseTemplate< TInternalComputationValueType >, itk::NiftiImageIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::MetaImageIO, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::BMPImageIO, itk::GiplImageIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, itk::STLMeshIO, itk::DCMTKImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::OBJMeshIO, itk::PolygonGroupSpatialObjectXMLFileReader, itk::MGHImageIO, itk::NrrdImageIO, itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::WeightSetBase< TMeasurementVector, TTargetVector >, itk::JPEGImageIO, itk::PNGImageIO, itk::DCMTKTransformIO< TInternalComputationValueType >, itk::Statistics::LayerBase< TMeasurementVector, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::MetaArrayWriter, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::MetaArrayReader, itk::MatlabTransformIOTemplate< ParametersValueType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::TxtTransformIOTemplate< TParametersValueType >, and itk::FDFImageIO.

virtual const float& itk::LightProcessObject::GetProgress ( ) const

virtual

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

static Pointer itk::LightProcessObject::New ( )

static

Method for creation through the object factory.

void itk::LightProcessObject::operator= ( const Self &  )

private

virtual void itk::LightProcessObject::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::Object.

Reimplemented in itk::ImageIOBase, itk::MeshIOBase, itk::GDCMImageIO, itk::MetaArrayReader, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::OFFMeshIO, itk::CSVFileReaderBase, itk::FreeSurferBinaryMeshIO, itk::MetaArrayWriter, itk::OBJMeshIO, itk::MetaImageIO, itk::FreeSurferAsciiMeshIO, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::FileListVideoIO, itk::Statistics::LayerBase< TMeasurementVector, TTargetVector >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::BYUMeshIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::RawImageIO< TPixel, VImageDimension >, itk::HDF5ImageIO, itk::STLMeshIO, itk::TIFFImageIO, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::OpenCVVideoIO, itk::VXLVideoIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::Statistics::WeightSetBase< TMeasurementVector, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::GiftiMeshIO, itk::IPLCommonImageIO, itk::CSVArray2DFileReader< TData >, itk::StimulateImageIO, itk::TransformIOBaseTemplate< TParametersValueType >, itk::TransformIOBaseTemplate< ParametersValueType >, itk::TransformIOBaseTemplate< TInternalComputationValueType >, itk::AnalyzeObjectLabelMapImageIO, itk::VideoIOBase, itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >, itk::VTKPolyDataMeshIO, itk::JPEG2000ImageIO, itk::NiftiImageIO, itk::VTKImageIO, itk::MRCImageIO, itk::DCMTKImageIO, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::FDFImageIO, itk::TransformFileWriterTemplate< TParametersValueType >, itk::BioRadImageIO, itk::JPEGImageIO, itk::VoxBoCUBImageIO, itk::StreamingImageIOBase, itk::LSMImageIO, itk::PNGImageIO, itk::TransformFileReaderTemplate< TParametersValueType >, itk::BMPImageIO, itk::MGHImageIO, itk::NrrdImageIO, itk::GiplImageIO, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::XMLReaderBase, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >, and itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >.

Referenced by itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >::PrintSelf().

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool  _arg )

virtual

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

virtual void itk::LightProcessObject::SetProgress ( float  _arg )

virtual

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual void itk::LightProcessObject::UpdateOutputData ( )

virtual

Actually generate new output.

void itk::LightProcessObject::UpdateProgress

(

float

amount

)

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Member Data Documentation

bool itk::LightProcessObject::m_AbortGenerateData

private

These support the progress method and aborting filter execution.

Definition at line 133 of file itkLightProcessObject.h.

float itk::LightProcessObject::m_Progress

private

Definition at line 134 of file itkLightProcessObject.h.

---

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

• itkLightProcessObject.h