OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | 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 SelfConstPointer
 
typedef std::map< std::string, GenericMapTypeGenericMapContainer
 
typedef std::map< std::string, std::string > GenericMapType
 
typedef std::pair< std::string, MeasurementVectorTypeInputDataType
 
typedef MeasurementVectorType::ValueType InputValueType
 
typedef std::vector< InputDataTypeMeasurementVectorContainer
 
typedef TMeasurementVector MeasurementVectorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StatisticsXMLFileReader Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void Modified () const override
 

Static Public Member Functions

static Pointer New ()
 
std::string m_FileName
 
MeasurementVectorContainer m_MeasurementVectorContainer
 
bool m_IsUpdated
 
GenericMapContainer m_GenericMapContainer
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
unsigned int GetNumberOfOutputs ()
 
std::vector< std::string > GetStatisticVectorNames ()
 
std::vector< std::string > GetStatisticMapNames ()
 
MeasurementVectorType GetStatisticVectorByName (const char *statisticName)
 
template<typename MapType >
MapType GetStatisticMapByName (const char *statisticName)
 
virtual void Read ()
 
 StatisticsXMLFileReader ()
 
 ~StatisticsXMLFileReader () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 StatisticsXMLFileReader (const Self &)=delete
 
void operator= (const Self &)=delete
 

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 42 of file otbStatisticsXMLFileReader.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file otbStatisticsXMLFileReader.h.

◆ GenericMapContainer

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

Definition at line 66 of file otbStatisticsXMLFileReader.h.

◆ GenericMapType

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

Definition at line 65 of file otbStatisticsXMLFileReader.h.

◆ InputDataType

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

Convenient typedef

Definition at line 62 of file otbStatisticsXMLFileReader.h.

◆ InputValueType

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

Definition at line 59 of file otbStatisticsXMLFileReader.h.

◆ MeasurementVectorContainer

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

Definition at line 63 of file otbStatisticsXMLFileReader.h.

◆ MeasurementVectorType

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

InputSampleList typedefs

Definition at line 55 of file otbStatisticsXMLFileReader.h.

◆ Pointer

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

Definition at line 48 of file otbStatisticsXMLFileReader.h.

◆ Self

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

Standard class typedefs

Definition at line 46 of file otbStatisticsXMLFileReader.h.

◆ Superclass

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

Definition at line 47 of file otbStatisticsXMLFileReader.h.

Constructor & Destructor Documentation

◆ StatisticsXMLFileReader() [1/2]

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

Set the output filename

Definition at line 35 of file otbStatisticsXMLFileReader.hxx.

◆ ~StatisticsXMLFileReader()

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

Set the output filename

Definition at line 99 of file otbStatisticsXMLFileReader.h.

◆ StatisticsXMLFileReader() [2/2]

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

Set the output filename

Member Function Documentation

◆ CreateAnother()

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

◆ GetFileName()

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

Set the output filename

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetNumberOfOutputs()

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

Get the number of Outputs

Definition at line 40 of file otbStatisticsXMLFileReader.hxx.

◆ GetStatisticMapByName()

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 110 of file otbStatisticsXMLFileReader.hxx.

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

◆ GetStatisticMapNames()

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

Get the list of map statistics names

Definition at line 63 of file otbStatisticsXMLFileReader.hxx.

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

◆ GetStatisticVectorByName()

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

Method to get the MeasurementVector by name

Definition at line 81 of file otbStatisticsXMLFileReader.hxx.

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

◆ GetStatisticVectorNames()

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

Get the list of vector statistics names

Definition at line 46 of file otbStatisticsXMLFileReader.hxx.

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

◆ Modified()

template<class TMeasurementVector >
void otb::StatisticsXMLFileReader< TMeasurementVector >::Modified ( ) const
inlineoverride

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Set the output filename

◆ PrintSelf()

template<class TMeasurementVector >
void otb::StatisticsXMLFileReader< TMeasurementVector >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Set the output filename

Definition at line 236 of file otbStatisticsXMLFileReader.hxx.

◆ Read()

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

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

Definition at line 138 of file otbStatisticsXMLFileReader.hxx.

◆ SetFileName()

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

Set the output filename

Member Data Documentation

◆ m_FileName

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

Set the output filename

Definition at line 108 of file otbStatisticsXMLFileReader.h.

◆ m_GenericMapContainer

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

Set the output filename

Definition at line 111 of file otbStatisticsXMLFileReader.h.

◆ m_IsUpdated

template<class TMeasurementVector >
bool otb::StatisticsXMLFileReader< TMeasurementVector >::m_IsUpdated
mutableprivate

Set the output filename

Definition at line 110 of file otbStatisticsXMLFileReader.h.

Referenced by otb::StatisticsXMLFileReader< TMeasurementVector >::Modified().

◆ m_MeasurementVectorContainer

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

Set the output filename

Definition at line 109 of file otbStatisticsXMLFileReader.h.


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