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

#include <itkLightProcessObject.h>

Inheritance diagram for itk::LightProcessObject:

Collaboration diagram for itk::LightProcessObject:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightProcessObject	Self
typedef Object	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetAbortGenerateData ()
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 ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	LightProcessObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~LightProcessObject ()
Private Attributes
bool	m_AbortGenerateData
float	m_Progress
virtual void	GenerateData ()
	LightProcessObject (const Self &)
void	operator= (const Self &)

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.

Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 79 of file itkLightProcessObject.h.

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

Reimplemented from itk::Object.

Definition at line 78 of file itkLightProcessObject.h.

typedef LightProcessObject itk::LightProcessObject::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 76 of file itkLightProcessObject.h.

typedef Object itk::LightProcessObject::Superclass

Reimplemented from itk::Object.

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]

This method causes the filter to generate its output.

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

Reimplemented in itk::BMPImageIO, itk::BioRadImageIO, itk::GDCMImageIO, itk::GiplImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::LSMImageIO, itk::MetaArrayReader, itk::MetaArrayWriter, itk::MetaImageIO, itk::NiftiImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::PolygonGroupSpatialObjectXMLFileReader, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::IPLCommonImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::AnalyzeImageIO, itk::DicomImageIO, itk::DICOMImageIO2, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::FreeSurferBinaryMeshIO, itk::GiftiMeshIO, itk::OBJMeshIO, itk::OFFMeshIO, itk::VTKPolyDataMeshIO, itk::CSVArray2DFileReader< TData >, itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >, itk::HDF5ImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::HDF5TransformIO, itk::MatlabTransformIO, itk::Bruker2DSEQImageIO, itk::JPEG2000ImageIO, itk::MINC2ImageIO, itk::MRCImageIO, itk::VoxBoCUBImageIO, and itk::FileListVideoIO.

virtual void itk::LightProcessObject::GenerateData ( void ) [inline, protected, virtual]

This method causes the filter to generate its output.

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

Definition at line 124 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [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.

virtual const float& itk::LightProcessObject::GetProgress ( ) [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.

Reimplemented from itk::Object.

Reimplemented in itk::BMPImageIO, itk::BioRadImageIO, itk::GDCMImageIO, itk::GiplImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::LSMImageIO, itk::MetaArrayReader, itk::MetaArrayWriter, itk::MetaImageIO, itk::NiftiImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::PolygonGroupSpatialObjectXMLFileReader, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::IPLCommonImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::AnalyzeImageIO, itk::DicomImageIO, itk::DICOMImageIO2, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::FreeSurferBinaryMeshIO, itk::GiftiMeshIO, itk::OBJMeshIO, itk::OFFMeshIO, itk::VTKPolyDataMeshIO, itk::CSVArray2DFileReader< TData >, itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >, itk::HDF5ImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::HDF5TransformIO, itk::MatlabTransformIO, itk::Bruker2DSEQImageIO, itk::JPEG2000ImageIO, itk::MINC2ImageIO, itk::MRCImageIO, itk::VoxBoCUBImageIO, and itk::FileListVideoIO.

void itk::LightProcessObject::operator= ( const Self & ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::Object.

Reimplemented in itk::ImageIOBase, itk::StreamingImageIOBase, itk::BMPImageIO, itk::BioRadImageIO, itk::GDCMImageIO, itk::GiplImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::LSMImageIO, itk::MetaImageIO, itk::NiftiImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::XMLReaderBase, itk::XMLReader< T >, itk::XMLWriterBase< T >, itk::PolygonGroupSpatialObjectXMLFileReader, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::IPLCommonImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, itk::AnalyzeImageIO, itk::DicomImageIO, itk::DICOMImageIO2, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::FreeSurferBinaryMeshIO, itk::GiftiMeshIO, itk::MeshIOBase, itk::OBJMeshIO, itk::OFFMeshIO, itk::VTKPolyDataMeshIO, itk::CSVArray2DFileReader< TData >, itk::CSVFileReaderBase, itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >, itk::HDF5ImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::Bruker2DSEQImageIO, itk::JPEG2000ImageIO, itk::MINC2ImageIO, itk::MRCImageIO, itk::VoxBoCUBImageIO, itk::FileListVideoIO, itk::VideoIOBase, itk::ClassifierBase< TInputImage >, itk::XMLReader< PGroupSpatialObjectType >, and itk::XMLWriterBase< PGroupSpatialObjectType >.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation