OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::StatisticsXMLFileWriter< TMeasurementVector > Class Template Reference

#include <otbStatisticsXMLFileWriter.h>

+ Inheritance diagram for otb::StatisticsXMLFileWriter< TMeasurementVector >:
+ Collaboration diagram for otb::StatisticsXMLFileWriter< TMeasurementVector >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::map< std::string,
GenericMapType
GenericMapContainer
 
typedef std::map< std::string,
std::string > 
GenericMapType
 
typedef std::pair< std::string,
MeasurementVectorType
InputDataType
 
typedef
MeasurementVectorType::ValueType 
InputValueType
 
typedef std::vector
< InputDataType
MeasurementVectorContainer
 
typedef TMeasurementVector MeasurementVectorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StatisticsXMLFileWriter Self
 
typedef itk::Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void AddInput (const char *name, const MeasurementVectorType &inputVector)
 
template<typename MapType >
void AddInputMap (const char *name, const MapType &map)
 
void CleanInputs ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void Update ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- 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 ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 StatisticsXMLFileWriter ()
 
 ~StatisticsXMLFileWriter () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 Member Functions

void operator= (const Self &)=delete
 
 StatisticsXMLFileWriter (const Self &)=delete
 

Private Attributes

std::string m_FileName
 
GenericMapContainer m_GenericMapContainer
 
MeasurementVectorContainer m_MeasurementVectorContainer
 

Additional Inherited Members

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

Detailed Description

template<class TMeasurementVector>
class otb::StatisticsXMLFileWriter< TMeasurementVector >

Write in a xml file the values stored in a MeasurementVector set as input.

The vector can be set as input via AddInput(name, vector) where name is the name of the statistic, and vector the values. Supported vector types are those implementing the method GetElement(idx) and defining the type ValueType.

Definition at line 43 of file otbStatisticsXMLFileWriter.h.

Member Typedef Documentation

template<class TMeasurementVector >
typedef itk::SmartPointer<const Self> otb::StatisticsXMLFileWriter< TMeasurementVector >::ConstPointer

Definition at line 51 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef std::map<std::string , GenericMapType> otb::StatisticsXMLFileWriter< TMeasurementVector >::GenericMapContainer

Definition at line 68 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef std::map<std::string , std::string> otb::StatisticsXMLFileWriter< TMeasurementVector >::GenericMapType

Definition at line 67 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef std::pair<std::string , MeasurementVectorType> otb::StatisticsXMLFileWriter< TMeasurementVector >::InputDataType

Convenient typedef

Definition at line 64 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef MeasurementVectorType::ValueType otb::StatisticsXMLFileWriter< TMeasurementVector >::InputValueType

Definition at line 61 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef std::vector< InputDataType > otb::StatisticsXMLFileWriter< TMeasurementVector >::MeasurementVectorContainer

Definition at line 65 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef TMeasurementVector otb::StatisticsXMLFileWriter< TMeasurementVector >::MeasurementVectorType

InputSampleList typedefs

Definition at line 57 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef itk::SmartPointer< Self > otb::StatisticsXMLFileWriter< TMeasurementVector >::Pointer

Definition at line 50 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef StatisticsXMLFileWriter otb::StatisticsXMLFileWriter< TMeasurementVector >::Self

Standard class typedefs

Definition at line 48 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
typedef itk::Object otb::StatisticsXMLFileWriter< TMeasurementVector >::Superclass

Definition at line 49 of file otbStatisticsXMLFileWriter.h.

Constructor & Destructor Documentation

template<class TMeasurementVector >
otb::StatisticsXMLFileWriter< TMeasurementVector >::StatisticsXMLFileWriter ( )
protected

Definition at line 35 of file otbStatisticsXMLFileWriter.hxx.

template<class TMeasurementVector >
otb::StatisticsXMLFileWriter< TMeasurementVector >::~StatisticsXMLFileWriter ( )
inlineoverrideprotected

Definition at line 96 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
otb::StatisticsXMLFileWriter< TMeasurementVector >::StatisticsXMLFileWriter ( const Self )
privatedelete

Member Function Documentation

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::AddInput ( const char *  name,
const MeasurementVectorType inputVector 
)

Method to set/get the input list sample

Definition at line 42 of file otbStatisticsXMLFileWriter.hxx.

template<class TMeasurementVector >
template<typename MapType >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::AddInputMap ( const char *  name,
const MapType &  map 
)

Method to add a map statistic with a given type

Definition at line 161 of file otbStatisticsXMLFileWriter.hxx.

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::CleanInputs ( )

Remove previously added inputs (vectors and maps)

Definition at line 187 of file otbStatisticsXMLFileWriter.hxx.

template<class TMeasurementVector >
virtual::itk::LightObject::Pointer otb::StatisticsXMLFileWriter< TMeasurementVector >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::GenerateData ( void  )
protectedvirtual
template<class TMeasurementVector >
virtual const char* otb::StatisticsXMLFileWriter< TMeasurementVector >::GetFileName ( ) const
virtual

Set the output filename

template<class TMeasurementVector >
virtual const char* otb::StatisticsXMLFileWriter< TMeasurementVector >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TMeasurementVector >
static Pointer otb::StatisticsXMLFileWriter< TMeasurementVector >::New ( )
static

Method for creation through the object factory.

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::operator= ( const Self )
privatedelete
template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::Object.

Definition at line 197 of file otbStatisticsXMLFileWriter.hxx.

template<class TMeasurementVector >
virtual void otb::StatisticsXMLFileWriter< TMeasurementVector >::SetFileName ( const char *  _arg)
virtual

Set the output filename

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::Update ( void  )
inline

Trigger the processing

Definition at line 81 of file otbStatisticsXMLFileWriter.h.

References otb::StatisticsXMLFileWriter< TMeasurementVector >::GenerateData().

Member Data Documentation

template<class TMeasurementVector >
std::string otb::StatisticsXMLFileWriter< TMeasurementVector >::m_FileName
private

Definition at line 103 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
GenericMapContainer otb::StatisticsXMLFileWriter< TMeasurementVector >::m_GenericMapContainer
private

Definition at line 105 of file otbStatisticsXMLFileWriter.h.

template<class TMeasurementVector >
MeasurementVectorContainer otb::StatisticsXMLFileWriter< TMeasurementVector >::m_MeasurementVectorContainer
private

Definition at line 104 of file otbStatisticsXMLFileWriter.h.


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