Orfeo Toolbox  3.16
Public Types | Public Member Functions | Private Attributes
itk::ResourceProbe< ValueType, MeanType > Class Template Reference

Class for computing the change of a value between two points in the code. More...

#include <itkResourceProbe.h>

+ Inheritance diagram for itk::ResourceProbe< ValueType, MeanType >:
+ Collaboration diagram for itk::ResourceProbe< ValueType, MeanType >:

List of all members.

Public Types

typedef unsigned long CountType

Public Member Functions

 ResourceProbe (const std::string &type, const std::string &unit)
virtual ~ResourceProbe ()
virtual ValueType GetInstantValue (void) const =0
MeanType GetMean (void) const
CountType GetNumberOfStarts (void) const
CountType GetNumberOfStops (void) const
ValueType GetTotal (void) const
std::string GetType (void) const
std::string GetUnit (void) const
void Start (void)
void Stop (void)

Private Attributes

CountType m_NumberOfStarts
CountType m_NumberOfStops
ValueType m_StartValue
ValueType m_TotalValue
std::string m_TypeString
std::string m_UnitString

Detailed Description

template<class ValueType, class MeanType>
class itk::ResourceProbe< ValueType, MeanType >

Class for computing the change of a value between two points in the code.

This class is the base class of all the probes (time, memory, etc.) between the execution of two pieces of code. It can be started and stopped in order to evaluate the execution over multiple passes.

See also:
TimeResourceProbe, MemoryResourceProbe

Definition at line 39 of file itkResourceProbe.h.


Member Typedef Documentation

template<class ValueType, class MeanType>
typedef unsigned long itk::ResourceProbe< ValueType, MeanType >::CountType

Type for counting how many times the probe has been started and stopped.

Reimplemented in itk::TimeProbe.

Definition at line 45 of file itkResourceProbe.h.


Constructor & Destructor Documentation

template<class ValueType , class MeanType >
itk::ResourceProbe< ValueType, MeanType >::ResourceProbe ( const std::string &  type,
const std::string &  unit 
)

Constructor

Definition at line 32 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
itk::ResourceProbe< ValueType, MeanType >::~ResourceProbe ( )
virtual

Destructor

Definition at line 44 of file itkResourceProbe.txx.


Member Function Documentation

template<class ValueType, class MeanType>
virtual ValueType itk::ResourceProbe< ValueType, MeanType >::GetInstantValue ( void  ) const
pure virtual

Returns the instant value of the probed system.

Implemented in itk::TimeProbe, and itk::MemoryProbe.

template<class ValueType , class MeanType >
MeanType itk::ResourceProbe< ValueType, MeanType >::GetMean ( void  ) const

Returns the average value changes between the starts and stops of the probe. Stop() has to be called at least once, returns 0 otherwise.

Get Mean

Definition at line 121 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
ResourceProbe< ValueType, MeanType >::CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStarts ( void  ) const

Returns the number of times that the probe has been started

Get Number of Starts

Definition at line 94 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
ResourceProbe< ValueType, MeanType >::CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStops ( void  ) const

Returns the number of times that the probe has been stopped

Get Number of Stops

Definition at line 103 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
ValueType itk::ResourceProbe< ValueType, MeanType >::GetTotal ( void  ) const
template<class ValueType , class MeanType >
std::string itk::ResourceProbe< ValueType, MeanType >::GetType ( void  ) const

Returns the type probed value

Definition at line 52 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
std::string itk::ResourceProbe< ValueType, MeanType >::GetUnit ( void  ) const

Returns the unit probed value

Definition at line 61 of file itkResourceProbe.txx.

template<class ValueType , class MeanType >
void itk::ResourceProbe< ValueType, MeanType >::Start ( void  )

Start counting the change of value

Start counting

Definition at line 70 of file itkResourceProbe.txx.

Referenced by otb::OGRIOHelper::ConvertOGRLayerToDataTreeNode(), otb::ImageAlternateViewer< TPixel >::CreateAdditionalBuffer(), otb::VectorDataEditionModel::DeleteSelectedGeometriesInROI(), otb::ImageAlternateViewer< TPixel >::Draw(), otb::GeometriesToGeometriesFilter::GenerateData(), otb::PersistentImageToOGRLayerFilter< TImage >::GenerateData(), otb::VectorDataTransformFilter< TInputVectorData, TOutputVectorData >::GenerateData(), otb::VectorDataToVectorDataFilter< TInputVectorData, TOutputVectorData >::GenerateData(), itk::IterativeInverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GenerateData(), otb::VectorDataExtractROI< TVectorData >::GenerateData(), otb::PersistentImageToOGRDataFilter< TImage >::GenerateData(), otb::VectorDataProjectionFilter< TInputVectorData, TOutputVectorData >::GenerateData(), otb::PersistentImageToOGRLayerSegmentationFilter< TImageType, TSegmentationFilter >::ProcessTile(), otb::ImageLayerRenderingModel< TOutputImage, TLayer >::RasterizeVisibleLayers(), otb::JPEG2000ImageIO::Read(), otb::GDALImageIO::Read(), otb::VectorDataGlComponent< TVectorData >::Render(), otb::ImageLayer< TImage, TOutputImage >::RenderImages(), otb::VectorDataEditionModel::SearchDataNodeIndexFromPoint(), itk::XMLFilterWatcher::StartFilter(), itk::SimpleFilterWatcher::StartFilter(), otb::VectorDataEditionModel::UpdateGeometryPosition(), otb::OGRVectorDataIO::Write(), otb::KMLVectorDataIO::Write(), and otb::GDALImageIO::Write().

template<class ValueType , class MeanType >
void itk::ResourceProbe< ValueType, MeanType >::Stop ( void  )

Member Data Documentation

template<class ValueType, class MeanType>
CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStarts
private

Definition at line 91 of file itkResourceProbe.h.

template<class ValueType, class MeanType>
CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStops
private

Definition at line 92 of file itkResourceProbe.h.

template<class ValueType, class MeanType>
ValueType itk::ResourceProbe< ValueType, MeanType >::m_StartValue
private

Definition at line 88 of file itkResourceProbe.h.

template<class ValueType, class MeanType>
ValueType itk::ResourceProbe< ValueType, MeanType >::m_TotalValue
private

Definition at line 89 of file itkResourceProbe.h.

template<class ValueType, class MeanType>
std::string itk::ResourceProbe< ValueType, MeanType >::m_TypeString
private

Definition at line 94 of file itkResourceProbe.h.

template<class ValueType, class MeanType>
std::string itk::ResourceProbe< ValueType, MeanType >::m_UnitString
private

Definition at line 95 of file itkResourceProbe.h.


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

Generated at Sun Feb 3 2013 02:25:07 for Orfeo Toolbox with doxygen 1.8.1.1