OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue > Class Template Reference

#include <otbTrainDimensionalityReductionApplicationBase.h>

+ Inheritance diagram for otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >:
+ Collaboration diagram for otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TInputValue InputValueType
 
typedef
ModelType::InputListSampleType 
ListSampleType
 
typedef
otb::DimensionalityReductionModelFactory
< InputValueType,
OutputValueType
ModelFactoryType
 
typedef
ModelFactoryType::DimensionalityReductionModelTypePointer 
ModelPointerType
 
typedef
ModelFactoryType::DimensionalityReductionModelType 
ModelType
 
typedef TOutputValue OutputValueType
 
typedef SampleImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef otb::VectorImage
< InputValueType
SampleImageType
 
typedef ModelType::InputSampleType SampleType
 
typedef
TrainDimensionalityReductionApplicationBase 
Self
 
typedef Application Superclass
 
- Public Types inherited from otb::Wrapper::Application
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Application 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 const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::Wrapper::Application
void AddDocTag (const std::string &)
 
unsigned int AddExample (const std::string &comm="")
 
void AddImageToParameterInputImageList (std::string parameter, ImageBaseType *img)
 
void AddParameterStringList (std::string parameter, const std::string &str)
 
void ClearParameterInputImageList (std::string parameter)
 
void ClearValue (std::string paramKey)
 
void DisableParameter (std::string paramKey)
 
void EnableParameter (std::string paramKey)
 
int Execute ()
 
int ExecuteAndWriteOutput ()
 
void FreeRessources ()
 
std::vector< std::string > GetChoiceKeys (std::string paramKey)
 
std::vector< std::string > GetChoiceNames (std::string paramKey)
 
std::string GetCLExample ()
 
float GetDefaultParameterFloat (std::string parameter)
 
int GetDefaultParameterInt (std::string parameter)
 
virtual const char * GetDescription () const
 
virtual const char * GetDocAuthors () const
 
DocExampleStructure::Pointer GetDocExample ()
 
virtual const char * GetDocLimitations () const
 
virtual const std::string & GetDocLink () const
 
virtual const char * GetDocLongDescription () const
 
virtual const char * GetDocSeeAlso () const
 
virtual std::vector< std::string > GetDocTags () const
 
std::string GetExampleComment (unsigned int id)
 
unsigned int GetExampleNumberOfParameters (unsigned int id)
 
std::string GetExampleParameterKey (unsigned int exId, unsigned int paramId)
 
std::string GetExampleParameterValue (unsigned int exId, unsigned int paramId)
 
std::string GetHtmlExample ()
 
ImagePixelType GetImageBasePixelType (const std::string &key, unsigned int idx=0)
 
otb::ImageKeywordlist GetImageKeywordlist (const std::string &key, unsigned int idx=0)
 
itk::MetaDataDictionary GetImageMetaData (const std::string &key, unsigned int idx=0)
 
unsigned int GetImageNbBands (const std::string &key, unsigned int idx=0)
 
ImageBaseType::PointType GetImageOrigin (const std::string &key, unsigned int idx=0)
 
std::string GetImageProjection (const std::string &key, unsigned int idx=0)
 
ImageBaseType::RegionType GetImageRequestedRegion (const std::string &key, unsigned int idx=0)
 
ImageBaseType::SizeType GetImageSize (const std::string &key, unsigned int idx=0)
 
ImageBaseType::SpacingType GetImageSpacing (const std::string &key, unsigned int idx=0)
 
double GetLastExecutionTiming () const
 
bool GetListViewSingleSelectionMode (const std::string &parameter)
 
otb::LoggerGetLogger () const
 
virtual const char * GetName () const
 
unsigned int GetNumberOfElementsInParameterInputImageList (std::string parameter)
 
unsigned int GetNumberOfExamples ()
 
std::vector< std::pair
< std::string, std::string > > 
GetOutputParametersSumUp ()
 
std::string GetParameterAsString (std::string paramKey)
 
ParameterGetParameterByKey (std::string parameter, bool follow=true)
 
const ParameterGetParameterByKey (std::string parameter, bool follow=true) const
 
ComplexDoubleImageTypeGetParameterComplexDoubleImage (std::string)
 
ComplexDoubleVectorImageTypeGetParameterComplexDoubleVectorImage (std::string)
 
ComplexFloatImageTypeGetParameterComplexFloatImage (std::string)
 
ComplexFloatVectorImageTypeGetParameterComplexFloatVectorImage (std::string)
 
ComplexInt16ImageTypeGetParameterComplexInt16Image (std::string)
 
ComplexInt16VectorImageTypeGetParameterComplexInt16VectorImage (std::string)
 
ComplexInt32ImageTypeGetParameterComplexInt32Image (std::string)
 
ComplexInt32VectorImageTypeGetParameterComplexInt32VectorImage (std::string)
 
std::string GetParameterDescription (std::string paramKey)
 
DoubleImageTypeGetParameterDoubleImage (std::string)
 
DoubleVectorImageTypeGetParameterDoubleVectorImage (std::string)
 
float GetParameterFloat (std::string parameter)
 
FloatImageTypeGetParameterFloatImage (std::string)
 
FloatVectorImageTypeGetParameterFloatVectorImage (std::string)
 
FloatVectorImageTypeGetParameterImage (std::string parameter)
 
ImageBaseTypeGetParameterImageBase (const std::string &key, unsigned int idx=0)
 
FloatVectorImageListTypeGetParameterImageList (std::string parameter)
 
int GetParameterInt (std::string parameter)
 
Int16ImageTypeGetParameterInt16Image (std::string)
 
Int16VectorImageTypeGetParameterInt16VectorImage (std::string)
 
Int32ImageTypeGetParameterInt32Image (std::string)
 
Int32VectorImageTypeGetParameterInt32VectorImage (std::string)
 
ParameterGroupGetParameterList ()
 
std::string GetParameterName (std::string paramKey)
 
ImageBaseTypeGetParameterOutputImage (std::string parameter)
 
ImagePixelType GetParameterOutputImagePixelType (std::string parameter)
 
Role GetParameterRole (std::string paramKey) const
 
std::vector< std::string > GetParametersKeys (bool recursive=true)
 
std::string GetParameterString (std::string parameter)
 
std::vector< std::string > GetParameterStringList (const std::string &parameter)
 
ParameterType GetParameterType (std::string paramKey) const
 
UInt16ImageTypeGetParameterUInt16Image (std::string)
 
UInt16VectorImageTypeGetParameterUInt16VectorImage (std::string)
 
UInt32ImageTypeGetParameterUInt32Image (std::string)
 
UInt32VectorImageTypeGetParameterUInt32VectorImage (std::string)
 
UInt8ImageTypeGetParameterUInt8Image (std::string)
 
UInt8RGBAImageTypeGetParameterUInt8RGBAImage (std::string)
 
UInt8RGBImageTypeGetParameterUInt8RGBImage (std::string)
 
UInt8VectorImageTypeGetParameterUInt8VectorImage (std::string)
 
UserLevel GetParameterUserLevel (std::string paramKey) const
 
VectorDataTypeGetParameterVectorData (std::string parameter)
 
VectorDataListTypeGetParameterVectorDataList (std::string parameter)
 
std::string GetProgressDescription () const
 
itk::ProcessObjectGetProgressSource () const
 
bool HasAutomaticValue (std::string paramKey) const
 
bool HasUserValue (std::string paramKey) const
 
bool HasValue (std::string paramKey) const
 
void Init ()
 
bool IsApplicationReady ()
 
bool IsDeprecated ()
 
bool IsInitialized () const
 
bool IsMandatory (std::string paramKey) const
 
bool IsParameterEnabled (std::string paramKey, bool recurseParents=false) const
 
bool IsParameterMissing (const std::string &key) const
 
void LoadParametersFromXML (const std::string &filename)
 
unsigned long PropagateRequestedRegion (const std::string &key, ImageBaseType::RegionType region, unsigned int idx=0)
 
void RegisterPipeline ()
 
void SaveParametersToXML (const std::string &filename)
 
void SetDefaultOutputComplexPixelType (std::string parameter, ComplexImagePixelType type)
 
void SetDefaultOutputPixelType (std::string parameter, ImagePixelType type)
 
void SetDefaultParameterFloat (std::string parameter, float value)
 
void SetDefaultParameterInt (std::string parameter, int value)
 
void SetDescription (const std::string &)
 
virtual void SetDocAuthors (const std::string &)
 
void SetDocExampleParameterValue (const std::string key, const std::string value, unsigned int exId=0)
 
virtual void SetDocLimitations (const std::string &)
 
virtual void SetDocLink (const std::string &link)
 
virtual void SetDocLongDescription (const std::string &)
 
virtual void SetDocSeeAlso (const std::string &)
 
virtual void SetDocTags (std::vector< std::string >)
 
void SetExampleComment (const std::string &comm, unsigned int i)
 
void SetListViewSingleSelectionMode (std::string parameter, bool status)
 
void SetLogger (otb::Logger *logger)
 
void SetMaximumParameterFloatValue (std::string parameter, float value)
 
void SetMaximumParameterIntValue (std::string parameter, int value)
 
void SetMinimumParameterFloatValue (std::string parameter, float value)
 
void SetMinimumParameterIntValue (std::string parameter, int value)
 
virtual void SetName (const std::string &)
 
void SetNthParameterInputImageList (std::string parameter, const unsigned int &id, ImageBaseType *img)
 
void SetNthParameterStringList (std::string parameter, const unsigned int &id, const std::string &str)
 
void SetOfficialDocLink ()
 
void SetParameterDescription (std::string paramKey, std::string dec)
 
void SetParameterFloat (std::string parameter, float value, bool hasUserValueFlag=true)
 
void SetParameterImageBase (const std::string &key, ImageBaseType *img, unsigned int idx=0)
 
void SetParameterInputImage (std::string parameter, ImageBaseType *inputImage)
 
void SetParameterInt (std::string parameter, int value, bool hasUserValueFlag=true)
 
void SetParameterList (ParameterGroup::Pointer paramGroup)
 
void SetParameterOutputImage (std::string parameter, FloatVectorImageType *value)
 
void SetParameterOutputImagePixelType (std::string parameter, ImagePixelType pixelType)
 
void SetParameterOutputVectorData (std::string parameter, VectorDataType *value)
 
void SetParameterString (std::string parameter, std::string value, bool hasUserValueFlag=true)
 
void SetParameterStringList (std::string parameter, std::vector< std::string > values, bool hasUserValueFlag=true)
 
void SetParameterUserValue (std::string paramKey, bool value)
 
void Stop ()
 
void UpdateParameters ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
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
 

Protected Member Functions

void DoInit () override
 
void Reduce (typename ListSampleType::Pointer validationListSample, std::string modelPath)
 
void Train (typename ListSampleType::Pointer trainingListSample, std::string modelPath)
 
 TrainDimensionalityReductionApplicationBase ()
 
 ~TrainDimensionalityReductionApplicationBase () override
 
- Protected Member Functions inherited from otb::Wrapper::Application
void AddChoice (std::string paramKey, std::string paramName)
 
void AddParameter (ParameterType type, std::string paramKey, std::string paramName)
 
void AddProcess (itk::ProcessObject *object, std::string description)
 
void AddRAMParameter (std::string paramKey="ram")
 
void AddRAMParameter (std::string paramKey, std::string paramName, unsigned int defaultValue)
 
void AddRANDParameter (std::string paramKey="rand")
 
void AddRANDParameter (std::string paramKey, std::string paramName, unsigned int defaultValue)
 
 Application ()
 
void AutomaticValueOff (std::string paramKey)
 
void AutomaticValueOn (std::string paramKey)
 
void ClearChoices (std::string key)
 
template<class TImageType >
TImageType * GetParameterImage (std::string parameter)
 
std::vector< int > GetSelectedItems (std::string paramKey)
 
void MandatoryOff (std::string paramKey)
 
void MandatoryOn (std::string paramKey)
 
template<class TImageType >
void SetParameterOutputImage (std::string parameter, TImageType *value)
 
void SetParameterRole (std::string paramKey, Role role)
 
void SetParameterUserLevel (std::string paramKey, UserLevel level)
 
 ~Application () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
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 BeforeTrainSOM (typename ListSampleType::Pointer trainingListSample, std::string modelPath)
 
void InitSOMParams ()
 
template<class somchoice >
void TrainSOM (typename ListSampleType::Pointer trainingListSample, std::string modelPath)
 

Additional Inherited Members

- 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 Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TInputValue, class TOutputValue>
class otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >

Definition at line 70 of file otbTrainDimensionalityReductionApplicationBase.h.

Member Typedef Documentation

template<class TInputValue , class TOutputValue >
typedef itk::SmartPointer<const Self> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ConstPointer
template<class TInputValue , class TOutputValue >
typedef TInputValue otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::InputValueType
template<class TInputValue , class TOutputValue >
typedef ModelType::InputListSampleType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ListSampleType
template<class TInputValue , class TOutputValue >
typedef otb::DimensionalityReductionModelFactory< InputValueType, OutputValueType> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelFactoryType
template<class TInputValue , class TOutputValue >
typedef ModelFactoryType::DimensionalityReductionModelTypePointer otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelPointerType
template<class TInputValue , class TOutputValue >
typedef ModelFactoryType::DimensionalityReductionModelType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelType
template<class TInputValue , class TOutputValue >
typedef TOutputValue otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::OutputValueType
template<class TInputValue , class TOutputValue >
typedef SampleImageType::PixelType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::PixelType
template<class TInputValue , class TOutputValue >
typedef itk::SmartPointer<Self> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Pointer
template<class TInputValue , class TOutputValue >
typedef otb::VectorImage<InputValueType> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::SampleImageType
template<class TInputValue , class TOutputValue >
typedef ModelType::InputSampleType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::SampleType
template<class TInputValue , class TOutputValue >
typedef TrainDimensionalityReductionApplicationBase otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Self

Standard class typedefs.

Definition at line 74 of file otbTrainDimensionalityReductionApplicationBase.h.

template<class TInputValue , class TOutputValue >
typedef Application otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Superclass

Constructor & Destructor Documentation

template<class TInputValue , class TOutputValue >
otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::TrainDimensionalityReductionApplicationBase ( )
protected
template<class TInputValue , class TOutputValue >
otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::~TrainDimensionalityReductionApplicationBase ( )
overrideprotected

Member Function Documentation

template<class TInputValue , class TOutputValue >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::BeforeTrainSOM ( typename ListSampleType::Pointer  trainingListSample,
std::string  modelPath 
)
private

Definition at line 83 of file otbDimensionalityReductionTrainSOM.hxx.

References otbAppLogFATAL.

template<class TInputValue , class TOutputValue >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::DoInit ( )
overrideprotectedvirtual

Init method that creates all the parameters for machine learning models

Implements otb::Wrapper::Application.

Definition at line 46 of file otbTrainDimensionalityReductionApplicationBase.hxx.

References otb::Wrapper::Tags::Learning, and otb::Wrapper::ParameterType_Choice.

template<class TInputValue , class TOutputValue >
virtual const char* otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::GetNameOfClass ( ) const
virtual

Standard macro

Reimplemented from otb::Wrapper::Application.

template<class TInputValue , class TOutputValue >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::InitSOMParams ( )
private

Specific Init and Train methods for each machine learning model

Definition at line 33 of file otbDimensionalityReductionTrainSOM.hxx.

References otb::Wrapper::ParameterType_Float, otb::Wrapper::ParameterType_Int, and otb::Wrapper::ParameterType_StringList.

template<class TInputValue , class TOutputValue >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Reduce ( typename ListSampleType::Pointer  validationListSample,
std::string  modelPath 
)
protected

Generic method to load a model file and use it to classify a sample list

Definition at line 67 of file otbTrainDimensionalityReductionApplicationBase.hxx.

template<class TInputValue , class TOutputValue >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Train ( typename ListSampleType::Pointer  trainingListSample,
std::string  modelPath 
)
protected

Generic method to train and save the machine learning model. This method uses specific train methods depending on the chosen model.

Definition at line 74 of file otbTrainDimensionalityReductionApplicationBase.hxx.

References otbAppLogFATAL.

template<class TInputValue , class TOutputValue >
template<typename TSOM >
void otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::TrainSOM ( typename ListSampleType::Pointer  trainingListSample,
std::string  modelPath 
)
private

Definition at line 122 of file otbDimensionalityReductionTrainSOM.hxx.

References otbAppLogFATAL.


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