ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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
 
LightObject::Pointer CreateAnother () const override
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetReferenceCount (int) override
 
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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~Object () override
 
- 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 Attributes

bool m_AbortGenerateData
 
float m_Progress
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

Definition at line 81 of file itkLightProcessObject.h.

Definition at line 80 of file itkLightProcessObject.h.

Standard class type aliases.

Definition at line 78 of file itkLightProcessObject.h.

Definition at line 79 of file itkLightProcessObject.h.

Constructor & Destructor Documentation

itk::LightProcessObject::LightProcessObject ( )
protected
itk::LightProcessObject::~LightProcessObject ( )
overrideprotected

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::LightObject.

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

virtual void itk::LightProcessObject::GenerateData ( void  )
inlineprotectedvirtual
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::HDF5TransformIOTemplate< TParametersValueType >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::HDF5ImageIO, itk::MeshIOBase, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::Bruker2dseqImageIO, itk::CSVArray2DFileReader< TData >, itk::GDCMImageIO, itk::SCIFIOImageIO, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageIOBase, itk::MINCImageIO, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::CSVFileReaderBase, itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >, itk::StimulateImageIO, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::IPLCommonImageIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::MRCImageIO, itk::GE4ImageIO, itk::AnalyzeObjectLabelMapImageIO, itk::VideoIOBase, itk::TransformIOBaseTemplate< TParametersValueType >, itk::TransformIOBaseTemplate< ParametersValueType >, itk::TransformIOBaseTemplate< TInternalComputationValueType >, itk::VTKImageIO, itk::JPEG2000ImageIO, itk::OpenCVVideoIO, itk::VTKPolyDataMeshIO, itk::BioRadImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, itk::VoxBoCUBImageIO, itk::StreamingImageIOBase, itk::GEAdwImageIO, itk::VXLVideoIO, itk::GiftiMeshIO, itk::TransformFileWriterTemplate< TParametersValueType >, itk::RawImageIO< TPixel, VImageDimension >, itk::TransformFileReaderTemplate< TParametersValueType >, itk::LSMImageIO, itk::TIFFImageIO, itk::FreeSurferBinaryMeshIO, itk::NiftiImageIO, itk::BMPImageIO, itk::BYUMeshIO, itk::MetaImageIO, itk::FileListVideoIO, itk::GiplImageIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, itk::STLMeshIO, itk::DCMTKImageIO, itk::OBJMeshIO, itk::PNGImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, itk::MGHImageIO, itk::NrrdImageIO, itk::DCMTKTransformIO< TInternalComputationValueType >, itk::TxtTransformIOTemplate< TParametersValueType >, itk::JPEGImageIO, itk::MatlabTransformIOTemplate< ParametersValueType >, itk::MetaArrayWriter, and itk::MetaArrayReader.

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::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::LightObject.

Reimplemented in itk::ImageIOBase, itk::MeshIOBase, itk::GDCMImageIO, itk::MetaArrayReader, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::OFFMeshIO, itk::CSVFileReaderBase, itk::MetaImageIO, itk::FreeSurferBinaryMeshIO, itk::MetaArrayWriter, itk::OBJMeshIO, itk::FreeSurferAsciiMeshIO, itk::FileListVideoIO, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::OpenCVVideoIO, itk::TIFFImageIO, itk::BYUMeshIO, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::RawImageIO< TPixel, VImageDimension >, itk::NiftiImageIO, itk::STLMeshIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::HDF5ImageIO, itk::TransformIOBaseTemplate< TParametersValueType >, itk::TransformIOBaseTemplate< ParametersValueType >, itk::TransformIOBaseTemplate< TInternalComputationValueType >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::VXLVideoIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::Bruker2dseqImageIO, itk::IPLCommonImageIO, itk::GiftiMeshIO, itk::CSVArray2DFileReader< TData >, itk::MINCImageIO, itk::StimulateImageIO, itk::AnalyzeObjectLabelMapImageIO, itk::VideoIOBase, itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >, itk::JPEG2000ImageIO, itk::VTKPolyDataMeshIO, itk::VTKImageIO, itk::MRCImageIO, itk::DCMTKImageIO, itk::TransformFileWriterTemplate< TParametersValueType >, itk::PNGImageIO, itk::BioRadImageIO, itk::BMPImageIO, itk::JPEGImageIO, itk::VoxBoCUBImageIO, itk::StreamingImageIOBase, itk::LSMImageIO, itk::TransformFileReaderTemplate< TParametersValueType >, itk::MGHImageIO, itk::NrrdImageIO, itk::GiplImageIO, and itk::XMLReaderBase.

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 132 of file itkLightProcessObject.h.

float itk::LightProcessObject::m_Progress
private

Definition at line 133 of file itkLightProcessObject.h.


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