Orfeo Toolbox  3.16
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
itk::ProgressAccumulator Class Reference

Facilitates progress reporting for filters that wrap around multiple other filters. More...

#include <itkProgressAccumulator.h>

+ Inheritance diagram for itk::ProgressAccumulator:
+ Collaboration diagram for itk::ProgressAccumulator:

Classes

struct  FilterRecord
 

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef GenericFilterType::Pointer GenericFilterPointer
 
typedef ProcessObject GenericFilterType
 
typedef SmartPointer< Self > Pointer
 
typedef ProgressAccumulator Self
 
typedef Object Superclass
 

Public Member Functions

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 float GetAccumulatedProgress () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary (void)
 
const MetaDataDictionary & GetMetaDataDictionary (void) const
 
virtual const ProcessObject * GetMiniPipelineFilter ()
 
virtual unsigned long GetMTime () const
 
virtual const char * GetNameOfClass () const
 
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 RegisterInternalFilter (GenericFilterType *filter, float weight)
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void ResetFilterProgressAndKeepAccumulatedProgress ()
 
void ResetProgress ()
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetMiniPipelineFilter (ProcessObject *_arg)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
void UnregisterAllFilters ()
 

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

 ProgressAccumulator ()
 
virtual ~ProgressAccumulator ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &s, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Protected Attributes

InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Types

typedef CommandType::Pointer CommandPointer
 
typedef MemberCommand< Self > CommandType
 
typedef std::vector< struct
FilterRecord > 		FilterRecordVector
 

Private Member Functions

void ReportProgress (Object *object, const EventObject &event)
 

Private Attributes

float m_AccumulatedProgress
 
float m_BaseAccumulatedProgress
 
CommandPointer m_CallbackCommand
 
FilterRecordVector m_FilterRecord
 
GenericFilterPointer m_MiniPipelineFilter
 

Detailed Description

Facilitates progress reporting for filters that wrap around multiple other filters.

This object allows a mini-pipeline filters to easily keep track of the progress performed by the internal filters. See DiscreteGaussianImageFilter.txx for an implementation example.

See Also
DiscreteGaussianImageFilter

Definition at line 39 of file itkProgressAccumulator.h.

Member Typedef Documentation

typedef CommandType::Pointer itk::ProgressAccumulator::CommandPointer
private

Definition at line 94 of file itkProgressAccumulator.h.

typedef MemberCommand< Self > itk::ProgressAccumulator::CommandType
private

Command for observing progress of pipeline filters

Definition at line 93 of file itkProgressAccumulator.h.

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

Definition at line 46 of file itkProgressAccumulator.h.

typedef std::vector<struct FilterRecord> itk::ProgressAccumulator::FilterRecordVector
private

An array of record structures

Definition at line 120 of file itkProgressAccumulator.h.

typedef GenericFilterType::Pointer itk::ProgressAccumulator::GenericFilterPointer

Definition at line 50 of file itkProgressAccumulator.h.

typedef ProcessObject itk::ProgressAccumulator::GenericFilterType

Typedef for inputting filters

Definition at line 49 of file itkProgressAccumulator.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::ProgressAccumulator::Pointer

Definition at line 45 of file itkProgressAccumulator.h.

typedef ProgressAccumulator itk::ProgressAccumulator::Self

Standard class typedefs.

Definition at line 43 of file itkProgressAccumulator.h.

typedef Object itk::ProgressAccumulator::Superclass

Definition at line 44 of file itkProgressAccumulator.h.

Constructor & Destructor Documentation

itk::ProgressAccumulator::ProgressAccumulator ( )
protected

Definition at line 22 of file itkProgressAccumulator.cxx.

itk::ProgressAccumulator::~ProgressAccumulator ( )
protectedvirtual

Definition at line 35 of file itkProgressAccumulator.cxx.

Member Function Documentation

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(), 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::ProgressAccumulator::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.

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 float itk::ProgressAccumulator::GetAccumulatedProgress ( ) const
virtual

Get the total progress accumulated by this object

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.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns
A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

virtual const ProcessObject* itk::ProgressAccumulator::GetMiniPipelineFilter ( )
virtual

Set the mini-pipeline filter

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

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

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(), otb::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::ProgressAccumulator::GetNameOfClass ( ) const
virtual

Runtime information support.

Reimplemented from itk::Object.

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.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputFilenameListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputFilenameListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputFilenameListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputFilenameListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), otb::Wrapper::InputImageListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), otb::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputFilenameListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputFilenameListParameter::SetNthFileName(), otb::ImageIOBase::SetNumberOfDimensions(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), otb::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

static Pointer itk::ProgressAccumulator::New ( )
static

Standard New method.

Referenced by itk::NormalizeImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::ClosingOpeningMorphologicalFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), otb::MorphologicalPyramid::Resampler< TInputImage, TOutputImage >::GenerateData(), otb::OpeningClosingMorphologicalFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::BinaryMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::GenerateData(), itk::BinaryMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >::GenerateData(), itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >::GenerateData(), itk::BinaryFillholeImageFilter< TInputImage >::GenerateData(), itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::LaplacianSharpeningImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::MorphologicalWatershedImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::BinaryGrindPeakImageFilter< TInputImage >::GenerateData(), itk::OtsuMultipleThresholdsImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::AngularProjectionSetImageFilter< TInputImage, TOutputImage, TAngleList, TPrecision >::GenerateData(), itk::ApproximateSignedDistanceMapImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::WhiteTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::HausdorffDistanceImageFilter< TInputImage1, TInputImage2 >::GenerateData(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GrayscaleConnectedClosingImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GrayscaleConnectedOpeningImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::HConcaveImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::HConvexImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::AttributeRelabelImageFilter< TInputImage, TLabelObject, TLabelObjectValuator, TAttributeAccessor >::GenerateData(), itk::GrayscaleFillholeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::ClosingByReconstructionImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::LabelImageToShapeLabelMapFilter< TInputImage, TOutputImage >::GenerateData(), itk::ContourMeanDistanceImageFilter< TInputImage1, TInputImage2 >::GenerateData(), itk::OpeningByReconstructionImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::RegionalMinimaImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::LaplacianImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::RegionalMaximaImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::HMinimaImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::HMaximaImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::LabelAttributeKeepNObjectsImageFilter< TInputImage, TLabelObject, TLabelObjectValuator, TAttributeAccessor >::GenerateData(), itk::LabelAttributeOpeningImageFilter< TInputImage, TLabelObject, TLabelObjectValuator, TAttributeAccessor >::GenerateData(), itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::ShapeRelabelImageFilter< TInputImage >::GenerateData(), itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::KappaSigmaThresholdImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateData(), itk::RobustAutomaticThresholdImageFilter< TInputImage, TGradientImage, TOutputImage >::GenerateData(), itk::BinaryImageToShapeLabelMapFilter< TInputImage, TOutputImage >::GenerateData(), itk::LabelShapeKeepNObjectsImageFilter< TInputImage >::GenerateData(), itk::LabelReconstructionByDilationImageFilter< TInputImage >::GenerateData(), itk::LabelShapeOpeningImageFilter< TInputImage >::GenerateData(), itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::DoubleThresholdImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::BinaryAttributeKeepNObjectsImageFilter< TInputImage, TLabelObject, TLabelObjectValuator, TAttributeAccessor >::GenerateData(), itk::HessianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::SparseUnmixingImageFilter< TInputImage, TOutputImage, VNbInputImage, TPrecision, TMotherWaveletOperator >::GenerateData(), itk::BinaryAttributeOpeningImageFilter< TInputImage, TLabelObject, TLabelObjectValuator, TAttributeAccessor >::GenerateData(), itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::BinaryShapeOpeningImageFilter< TInputImage >::GenerateData(), itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::ZeroCrossingBasedEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GenerateData(), itk::BinaryReconstructionByDilationImageFilter< TInputImage >::GenerateData(), itk::BinaryReconstructionByErosionImageFilter< TInputImage >::GenerateData(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::GenerateData(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateData(), itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::StatisticsRelabelImageFilter< TInputImage, TFeatureImage >::GenerateData(), itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::GenerateData(), itk::LabelImageToStatisticsLabelMapFilter< TInputImage, TFeatureImage, TOutputImage >::GenerateData(), itk::LabelStatisticsOpeningImageFilter< TInputImage, TFeatureImage >::GenerateData(), itk::LabelStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GenerateData(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GenerateData(), itk::BinaryStatisticsOpeningImageFilter< TInputImage, TFeatureImage >::GenerateData(), itk::BinaryStatisticsKeepNObjectsImageFilter< TInputImage, TFeatureImage >::GenerateData(), itk::BinaryImageToStatisticsLabelMapFilter< TInputImage, TFeatureImage, TOutputImage >::GenerateData(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::UrbanAreaDetectionImageFilter< TInputImage, TOutputImage, TFunction >::GenerateData(), otb::GenericRSResampleImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::OrientImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::GenerateData(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::GenerateData(), otb::LmvmPanSharpeningFusionImageFilter< TPanImageType, TXsImageType, TOutputImageType, TInternalPrecision >::LmvmPanSharpeningFusionImageFilter(), and otb::SimpleRcsPanSharpeningFusionImageFilter< TPanImageType, TXsImageType, TOutputImageType, TInternalPrecision >::SimpleRcsPanSharpeningFusionImageFilter().

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::ProgressAccumulator::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 153 of file itkProgressAccumulator.cxx.

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::ProgressAccumulator::RegisterInternalFilter ( GenericFilterType *  filter,
float  weight 
)

Register a filter with the progress accumulator and specify the fraction of the overall progress associated with this filter

Definition at line 42 of file itkProgressAccumulator.cxx.

References itk::Object::AddObserver(), itk::ProgressAccumulator::FilterRecord::Filter, itk::ProgressAccumulator::FilterRecord::IterationObserverTag, itk::ProgressAccumulator::FilterRecord::Progress, itk::ProgressAccumulator::FilterRecord::ProgressObserverTag, and itk::ProgressAccumulator::FilterRecord::Weight.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GenerateData().

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

void itk::ProgressAccumulator::ReportProgress ( Object *  object,
const EventObject &  event 
)
private

A callback function that is called by the progressing filters

Definition at line 115 of file itkProgressAccumulator.cxx.

void itk::ProgressAccumulator::ResetFilterProgressAndKeepAccumulatedProgress ( )

Definition at line 100 of file itkProgressAccumulator.cxx.

void itk::ProgressAccumulator::ResetProgress ( )

Reset the progress accumulator. This method should be called in the beginning of the GenerateData() method in the mini-pipeline filter.

Definition at line 83 of file itkProgressAccumulator.cxx.

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

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::ProgressAccumulator::SetMiniPipelineFilter ( ProcessObject *  _arg)
virtual

Set the mini-pipeline filter

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::ProgressAccumulator::UnregisterAllFilters ( )

Unregister all filters that have been registered with this object

Definition at line 64 of file itkProgressAccumulator.cxx.

Member Data Documentation

float itk::ProgressAccumulator::m_AccumulatedProgress
private

The total accumulated progress

Definition at line 123 of file itkProgressAccumulator.h.

float itk::ProgressAccumulator::m_BaseAccumulatedProgress
private

The total accumulated progress for multiple runs of the mini-pipeline

Definition at line 126 of file itkProgressAccumulator.h.

CommandPointer itk::ProgressAccumulator::m_CallbackCommand
private

The callback command

Definition at line 135 of file itkProgressAccumulator.h.

FilterRecordVector itk::ProgressAccumulator::m_FilterRecord
private

A list of progress proportions of the different filters in the pipeline

Definition at line 132 of file itkProgressAccumulator.h.

GenericFilterPointer itk::ProgressAccumulator::m_MiniPipelineFilter
private

The client mini-pipeline filter

Definition at line 117 of file itkProgressAccumulator.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:
Generated at Sun May 19 2013 02:24:27 for Orfeo Toolbox with doxygen 1.8.3.1