OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | 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 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 StatisticsXMLFileWriter Self
 
typedef itk::Object Superclass
 

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

Static Public Member Functions

static Pointer New ()
 
std::string m_FileName
 
MeasurementVectorContainer m_MeasurementVectorContainer
 
GenericMapContainer m_GenericMapContainer
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void GenerateData ()
 
 StatisticsXMLFileWriter ()
 
 ~StatisticsXMLFileWriter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 StatisticsXMLFileWriter (const Self &)=delete
 
void operator= (const Self &)=delete
 

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 44 of file otbStatisticsXMLFileWriter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 51 of file otbStatisticsXMLFileWriter.h.

◆ GenericMapContainer

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

Definition at line 68 of file otbStatisticsXMLFileWriter.h.

◆ GenericMapType

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

Definition at line 67 of file otbStatisticsXMLFileWriter.h.

◆ InputDataType

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

Convenient typedef

Definition at line 64 of file otbStatisticsXMLFileWriter.h.

◆ InputValueType

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

Definition at line 61 of file otbStatisticsXMLFileWriter.h.

◆ MeasurementVectorContainer

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

Definition at line 65 of file otbStatisticsXMLFileWriter.h.

◆ MeasurementVectorType

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

InputSampleList typedefs

Definition at line 57 of file otbStatisticsXMLFileWriter.h.

◆ Pointer

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

Definition at line 50 of file otbStatisticsXMLFileWriter.h.

◆ Self

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

Standard class typedefs

Definition at line 48 of file otbStatisticsXMLFileWriter.h.

◆ Superclass

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

Definition at line 49 of file otbStatisticsXMLFileWriter.h.

Constructor & Destructor Documentation

◆ StatisticsXMLFileWriter() [1/2]

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

Set the output filename

Definition at line 35 of file otbStatisticsXMLFileWriter.hxx.

◆ ~StatisticsXMLFileWriter()

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

Set the output filename

Definition at line 95 of file otbStatisticsXMLFileWriter.h.

◆ StatisticsXMLFileWriter() [2/2]

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

Set the output filename

Member Function Documentation

◆ AddInput()

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 41 of file otbStatisticsXMLFileWriter.hxx.

◆ AddInputMap()

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 152 of file otbStatisticsXMLFileWriter.hxx.

◆ CleanInputs()

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

Remove previously added inputs (vectors and maps)

Definition at line 175 of file otbStatisticsXMLFileWriter.hxx.

◆ CreateAnother()

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

◆ GenerateData()

template<class TMeasurementVector >
void otb::StatisticsXMLFileWriter< TMeasurementVector >::GenerateData
protectedvirtual

Set the output filename

Definition at line 60 of file otbStatisticsXMLFileWriter.hxx.

Referenced by otb::StatisticsXMLFileWriter< TMeasurementVector >::Update().

◆ GetFileName()

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

Set the output filename

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Set the output filename

◆ PrintSelf()

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

Set the output filename

Definition at line 183 of file otbStatisticsXMLFileWriter.hxx.

◆ SetFileName()

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

Set the output filename

◆ Update()

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

Trigger the processing

Definition at line 81 of file otbStatisticsXMLFileWriter.h.

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

Member Data Documentation

◆ m_FileName

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

Set the output filename

Definition at line 104 of file otbStatisticsXMLFileWriter.h.

◆ m_GenericMapContainer

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

Set the output filename

Definition at line 106 of file otbStatisticsXMLFileWriter.h.

◆ m_MeasurementVectorContainer

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

Set the output filename

Definition at line 105 of file otbStatisticsXMLFileWriter.h.


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