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 ()
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	LightProcessObject ()
	~LightProcessObject ()
virtual void	GenerateData ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	LightProcessObject (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_AbortGenerateData
float	m_Progress

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

Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 78 of file itkLightProcessObject.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

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

Reimplemented from itk::Object.

Definition at line 77 of file itkLightProcessObject.h.

typedef LightProcessObject itk::LightProcessObject::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 75 of file itkLightProcessObject.h.

typedef Object itk::LightProcessObject::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::PhilipsPAR, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::ClassifierBase< TDataContainer >, itk::ClassifierBase< TInputImage >, itk::ClassifierBase< TSample >, itk::ClassifierBase< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::GDCMImageIO, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::Brains2MaskImageIO, itk::ImageIOBase, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::MINC2ImageIO, itk::StimulateImageIO, otb::VectorDataIOBase, itk::MRCImageIO, itk::PhilipsRECImageIO, otb::SVMClassifier< TSample, TLabel >, itk::VoxBoCUBImageIO, otb::TileMapImageIO, itk::GE5ImageIO, itk::TransformFileReader, itk::GE4ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::TransformFileWriter, otb::SEMClassifier< TInputImage, TOutputImage >, itk::SiemensVisionImageIO, itk::IPLCommonImageIO, itk::NiftiImageIO, itk::StreamingImageIOBase, otb::GDALImageIO, otb::KMLVectorDataIO, otb::OGRVectorDataIO, itk::VTKImageIO2, otb::JPEG2000ImageIO, itk::BioRadImageIO, itk::GiplImageIO, itk::VTKImageIO, otb::BSQImageIO, otb::ONERAImageIO, itk::DicomImageIO, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::TransformFileReader, otb::LUMImageIO, otb::MWImageIO, otb::RADImageIO, itk::BMPImageIO, itk::NrrdImageIO, itk::TransformIOBase, itk::LSMImageIO, itk::MetaImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, itk::TIFFImageIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::JPEGImageIO, itk::PNGImageIO, itk::Statistics::LayerBase< TMeasurementVector, TTargetVector >, itk::Statistics::WeightSetBase< TMeasurementVector, TTargetVector >, otb::MSTARImageIO, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >, itk::DICOMImageIO2, itk::MetaArrayReader, itk::MetaArrayWriter, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::TransformFileWriter, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::MatlabTransformIO, and itk::TxtTransformIO.

Definition at line 76 of file itkLightProcessObject.h.

Constructor & Destructor Documentation

itk::LightProcessObject::LightProcessObject ( )

protected

Instantiate object with no start, end, or progress methods.

Definition at line 28 of file itkLightProcessObject.cxx.

itk::LightProcessObject::~LightProcessObject ( )

protected

Destructor for the LightProcessObject class. We've got to UnRegister() the use of any input classes.

Definition at line 40 of file itkLightProcessObject.cxx.

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.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

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::PhilipsPAR, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::GDCMImageIO, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Brains2MaskImageIO, itk::IPLCommonImageIO, itk::MINC2ImageIO, itk::StimulateImageIO, otb::SVMClassifier< TSample, TLabel >, itk::MRCImageIO, itk::PhilipsRECImageIO, itk::VoxBoCUBImageIO, otb::TileMapImageIO, itk::GE5ImageIO, otb::SEMClassifier< TInputImage, TOutputImage >, itk::GE4ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, otb::GDALImageIO, itk::NiftiImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, otb::KMLVectorDataIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::TransformFileReader, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, otb::BSQImageIO, otb::OGRVectorDataIO, itk::VTKImageIO2, otb::LUMImageIO, otb::MWImageIO, otb::RADImageIO, itk::TransformFileWriter, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, otb::JPEG2000ImageIO, itk::BioRadImageIO, itk::GiplImageIO, itk::VTKImageIO, otb::ONERAImageIO, itk::BMPImageIO, itk::DicomImageIO, itk::NrrdImageIO, itk::LSMImageIO, itk::MetaImageIO, itk::TIFFImageIO, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::JPEGImageIO, itk::PNGImageIO, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, otb::MSTARImageIO, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::TransformFileWriter, itk::MetaArrayWriter, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::DICOMImageIO2, itk::MetaArrayReader, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::TransformFileReader, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::MatlabTransformIO, and itk::TxtTransformIO.

Referenced by itk::StreamingImageIOBase::GetActualNumberOfSplitsForWriting().

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

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::ClassifierBase< TSample >, itk::ClassifierBase< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, otb::SVMClassifier< TSample, TLabel >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, and otb::SVMMarginSampler< TSample, TModel >.

Definition at line 121 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.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

static Pointer itk::LightProcessObject::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::PhilipsPAR, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::GDCMImageIO, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Brains2MaskImageIO, itk::IPLCommonImageIO, itk::MINC2ImageIO, itk::StimulateImageIO, otb::SVMClassifier< TSample, TLabel >, itk::MRCImageIO, itk::PhilipsRECImageIO, itk::VoxBoCUBImageIO, otb::TileMapImageIO, itk::GE5ImageIO, otb::SEMClassifier< TInputImage, TOutputImage >, itk::GE4ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, otb::GDALImageIO, itk::NiftiImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, otb::KMLVectorDataIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::TransformFileReader, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, otb::BSQImageIO, otb::OGRVectorDataIO, itk::VTKImageIO2, otb::LUMImageIO, otb::MWImageIO, otb::RADImageIO, itk::TransformFileWriter, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, otb::JPEG2000ImageIO, itk::BioRadImageIO, itk::GiplImageIO, itk::VTKImageIO, otb::ONERAImageIO, itk::BMPImageIO, itk::DicomImageIO, itk::NrrdImageIO, itk::LSMImageIO, itk::MetaImageIO, itk::TIFFImageIO, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::JPEGImageIO, itk::PNGImageIO, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, otb::MSTARImageIO, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::TransformFileWriter, itk::MetaArrayWriter, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::DICOMImageIO2, itk::MetaArrayReader, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::TransformFileReader, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::MatlabTransformIO, and itk::TxtTransformIO.

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

private

Reimplemented from itk::Object.

Reimplemented in itk::ImageIOBase, itk::SiemensVisionImageIO, itk::GDCMImageIO, itk::PhilipsPAR, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::XMLWriterBase< T >, itk::XMLWriterBase< PGroupSpatialObjectType >, itk::StreamingImageIOBase, itk::IPLCommonImageIO, itk::MetaImageIO, itk::ClassifierBase< TInputImage >, itk::ClassifierBase< TSample >, itk::ClassifierBase< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::TIFFImageIO, itk::PhilipsRECImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::MINC2ImageIO, itk::NiftiImageIO, itk::GE5ImageIO, itk::StimulateImageIO, itk::GE4ImageIO, itk::GEAdwImageIO, itk::MRCImageIO, itk::DICOMImageIO2, itk::Brains2MaskImageIO, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::XMLReader< T >, itk::XMLReader< PGroupSpatialObjectType >, itk::JPEGImageIO, itk::VTKImageIO2, itk::VoxBoCUBImageIO, itk::PNGImageIO, itk::NrrdImageIO, itk::BioRadImageIO, itk::VTKImageIO, itk::GiplImageIO, itk::BMPImageIO, itk::LSMImageIO, itk::TransformFileWriter, itk::TransformFileWriter, itk::XMLReaderBase, itk::TransformFileReader, itk::PolygonGroupSpatialObjectXMLFileReader, itk::TransformFileReader, and itk::DicomImageIO.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

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

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 63 of file itkLightProcessObject.cxx.

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

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

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.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

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.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::LightProcessObject::UpdateOutputData ( void )

virtual

Actually generate new output.

GenerateData this object - we have not aborted yet, and our progress before we start to execute is 0.0.

 If we ended due to aborting, push the progress up to 1.0 (since
 it probably didn't end there)

Definition at line 77 of file itkLightProcessObject.cxx.

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

Definition at line 51 of file itkLightProcessObject.cxx.

Member Data Documentation

bool itk::LightProcessObject::m_AbortGenerateData

private

These support the progress method and aborting filter execution.

Definition at line 131 of file itkLightProcessObject.h.

float itk::LightProcessObject::m_Progress

private

Definition at line 132 of file itkLightProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation