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::StatisticsXMLFileReader< TMeasurementVector > Class Template Reference

#include <otbStatisticsXMLFileReader.h>

+ Inheritance diagram for otb::StatisticsXMLFileReader< TMeasurementVector >:
+ Collaboration diagram for otb::StatisticsXMLFileReader< 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 StatisticsXMLFileReader 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

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfOutputs ()
 
template<typename MapType >
MapType GetStatisticMapByName (const char *statisticName)
 
std::vector< std::string > GetStatisticMapNames ()
 
MeasurementVectorType GetStatisticVectorByName (const char *statisticName)
 
std::vector< std::string > GetStatisticVectorNames ()
 
void Modified () const override
 
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 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

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
virtual void Read ()
 
 StatisticsXMLFileReader ()
 
 ~StatisticsXMLFileReader () 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
 
 StatisticsXMLFileReader (const Self &)=delete
 

Private Attributes

std::string m_FileName
 
GenericMapContainer m_GenericMapContainer
 
bool m_IsUpdated
 
MeasurementVectorContainer m_MeasurementVectorContainer
 

Additional Inherited Members

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

Detailed Description

template<class TMeasurementVector>
class otb::StatisticsXMLFileReader< TMeasurementVector >

Read a xml file where are stored several statistics.

To get a specific statistic Measurement vector, use the method GetStatisticVectorByName(name) which allow you to get the Measurement vector for the statistic set as parameter.

Definition at line 41 of file otbStatisticsXMLFileReader.h.

Member Typedef Documentation

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

Definition at line 49 of file otbStatisticsXMLFileReader.h.

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

Definition at line 66 of file otbStatisticsXMLFileReader.h.

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

Definition at line 65 of file otbStatisticsXMLFileReader.h.

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

Convenient typedef

Definition at line 62 of file otbStatisticsXMLFileReader.h.

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

Definition at line 59 of file otbStatisticsXMLFileReader.h.

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

Definition at line 63 of file otbStatisticsXMLFileReader.h.

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

InputSampleList typedefs

Definition at line 55 of file otbStatisticsXMLFileReader.h.

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

Definition at line 48 of file otbStatisticsXMLFileReader.h.

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

Standard class typedefs

Definition at line 46 of file otbStatisticsXMLFileReader.h.

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

Definition at line 47 of file otbStatisticsXMLFileReader.h.

Constructor & Destructor Documentation

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

Definition at line 35 of file otbStatisticsXMLFileReader.hxx.

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

Definition at line 100 of file otbStatisticsXMLFileReader.h.

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

Member Function Documentation

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

Reimplemented from itk::Object.

template<class TMeasurementVector>
virtual const char* otb::StatisticsXMLFileReader< TMeasurementVector >::GetFileName ( ) const
virtual

Set the output filename

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TMeasurementVector >
unsigned int otb::StatisticsXMLFileReader< TMeasurementVector >::GetNumberOfOutputs ( )

Get the number of Outputs

Definition at line 42 of file otbStatisticsXMLFileReader.hxx.

template<class TMeasurementVector >
template<typename MapType >
MapType otb::StatisticsXMLFileReader< TMeasurementVector >::GetStatisticMapByName ( const char *  statisticName)

Method to get a statistics map by name

Definition at line 122 of file otbStatisticsXMLFileReader.hxx.

References otb::Wrapper::XML::Read().

template<class TMeasurementVector >
std::vector< std::string > otb::StatisticsXMLFileReader< TMeasurementVector >::GetStatisticMapNames ( )

Get the list of map statistics names

Definition at line 69 of file otbStatisticsXMLFileReader.hxx.

References otb::Wrapper::XML::Read().

template<class TMeasurementVector >
StatisticsXMLFileReader< TMeasurementVector >::MeasurementVectorType otb::StatisticsXMLFileReader< TMeasurementVector >::GetStatisticVectorByName ( const char *  statisticName)

Method to get the MeasurementVector by name

Definition at line 91 of file otbStatisticsXMLFileReader.hxx.

References otb::Wrapper::XML::Read().

template<class TMeasurementVector >
std::vector< std::string > otb::StatisticsXMLFileReader< TMeasurementVector >::GetStatisticVectorNames ( )

Get the list of vector statistics names

Definition at line 50 of file otbStatisticsXMLFileReader.hxx.

References otb::Wrapper::XML::Read().

template<class TMeasurementVector>
void otb::StatisticsXMLFileReader< TMeasurementVector >::Modified ( void  ) const
inlineoverridevirtual
template<class TMeasurementVector>
static Pointer otb::StatisticsXMLFileReader< TMeasurementVector >::New ( )
static

Method for creation through the object factory.

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

Reimplemented from itk::Object.

Definition at line 264 of file otbStatisticsXMLFileReader.hxx.

template<class TMeasurementVector >
void otb::StatisticsXMLFileReader< TMeasurementVector >::Read ( )
protectedvirtual

Read into the file and extract information in vector and map containers

Definition at line 154 of file otbStatisticsXMLFileReader.hxx.

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

Set the output filename

Member Data Documentation

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

Definition at line 107 of file otbStatisticsXMLFileReader.h.

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

Definition at line 110 of file otbStatisticsXMLFileReader.h.

template<class TMeasurementVector>
bool otb::StatisticsXMLFileReader< TMeasurementVector >::m_IsUpdated
mutableprivate
template<class TMeasurementVector>
MeasurementVectorContainer otb::StatisticsXMLFileReader< TMeasurementVector >::m_MeasurementVectorContainer
private

Definition at line 108 of file otbStatisticsXMLFileReader.h.


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