#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< Self >	Pointer

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< Self >	Pointer

typedef Application	Self

typedef itk::Object	Superclass

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 const &parameter, ImageBaseType *img)

void	AddParameterStringList (std::string const &parameter, const std::string &str)

void	ClearParameterInputImageList (std::string const &parameter)

void	ClearValue (std::string const &paramKey)

bool	ConnectImage (std::string in, Application *app, std::string out)

void	DisableParameter (std::string const &paramKey)

void	EnableParameter (std::string const &paramKey)

int	Execute ()

int	ExecuteAndWriteOutput ()

std::vector< std::string >	GetChoiceKeys (std::string const &paramKey)

std::vector< std::string >	GetChoiceNames (std::string const &paramKey)

std::string	GetCLExample ()

double	GetDefaultParameterDouble (std::string const &parameter)

float	GetDefaultParameterFloat (std::string const &parameter)

int	GetDefaultParameterInt (std::string const &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 ()

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::Logger *	GetLogger () const

virtual const char *	GetName () const

unsigned int	GetNumberOfElementsInParameterInputImageList (std::string const &parameter)

unsigned int	GetNumberOfExamples ()

std::vector< std::pair< std::string, std::string > >	GetOutputParametersSumUp ()

std::string	GetParameterAsString (std::string const &paramKey)

Parameter *	GetParameterByKey (std::string const &parameter, bool follow=true)

const Parameter *	GetParameterByKey (std::string const &parameter, bool follow=true) const

ComplexDoubleImageType *	GetParameterComplexDoubleImage (std::string const &)

ComplexDoubleVectorImageType *	GetParameterComplexDoubleVectorImage (std::string const &)

ComplexFloatImageType *	GetParameterComplexFloatImage (std::string const &)

ComplexFloatVectorImageType *	GetParameterComplexFloatVectorImage (std::string const &)

ComplexInt16ImageType *	GetParameterComplexInt16Image (std::string const &)

ComplexInt16VectorImageType *	GetParameterComplexInt16VectorImage (std::string const &)

ComplexInt32ImageType *	GetParameterComplexInt32Image (std::string const &)

ComplexInt32VectorImageType *	GetParameterComplexInt32VectorImage (std::string const &)

std::string	GetParameterDescription (std::string const &paramKey)

double	GetParameterDouble (std::string const &parameter) const

DoubleImageType *	GetParameterDoubleImage (std::string const &)

DoubleVectorImageType *	GetParameterDoubleVectorImage (std::string const &)

float	GetParameterFloat (std::string const &parameter) const

FloatImageType *	GetParameterFloatImage (std::string const &)

FloatVectorImageType *	GetParameterFloatVectorImage (std::string const &)

FloatVectorImageType *	GetParameterImage (std::string const &parameter)

FloatVectorImageListType *	GetParameterImageList (std::string const &parameter)

int	GetParameterInt (std::string const &parameter) const

Int16ImageType *	GetParameterInt16Image (std::string const &)

Int16VectorImageType *	GetParameterInt16VectorImage (std::string const &)

Int32ImageType *	GetParameterInt32Image (std::string const &)

Int32VectorImageType *	GetParameterInt32VectorImage (std::string const &)

ParameterGroup *	GetParameterList ()

std::string	GetParameterName (std::string const &paramKey)

ImageBaseType *	GetParameterOutputImage (std::string const &parameter)

ImagePixelType	GetParameterOutputImagePixelType (std::string const &parameter)

Role	GetParameterRole (std::string const &paramKey) const

std::vector< std::string >	GetParametersKeys (bool recursive=true)

std::string	GetParameterString (std::string const &parameter) const

std::vector< std::string >	GetParameterStringList (const std::string &parameter)

ParameterType	GetParameterType (std::string const &paramKey) const

UInt16ImageType *	GetParameterUInt16Image (std::string const &)

UInt16VectorImageType *	GetParameterUInt16VectorImage (std::string const &)

UInt32ImageType *	GetParameterUInt32Image (std::string const &)

UInt32VectorImageType *	GetParameterUInt32VectorImage (std::string const &)

UInt8ImageType *	GetParameterUInt8Image (std::string const &)

UInt8RGBAImageType *	GetParameterUInt8RGBAImage (std::string const &)

UInt8RGBImageType *	GetParameterUInt8RGBImage (std::string const &)

UInt8VectorImageType *	GetParameterUInt8VectorImage (std::string const &)

UserLevel	GetParameterUserLevel (std::string const &paramKey) const

VectorDataType *	GetParameterVectorData (std::string const &parameter)

VectorDataListType *	GetParameterVectorDataList (std::string const &parameter)

std::string	GetProgressDescription () const

itk::ProcessObject *	GetProgressSource () const

const FieldParameter::TypeFilterType &	GetTypeFilter (std::string const &key) const

bool	HasAutomaticValue (std::string const &paramKey) const

bool	HasUserValue (std::string const &paramKey) const

bool	HasValue (std::string const &paramKey) const

void	Init ()

bool	IsApplicationReady ()

bool	IsDeprecated ()

bool	IsInitialized () const

bool	IsMandatory (std::string const &paramKey) const

bool	IsParameterEnabled (std::string const &paramKey, bool recurseParents=false) const

bool	IsParameterMissing (const std::string &key) const

void	LoadParametersFromXML (const std::string &filename)

void	PropagateConnectMode (bool isMem)

unsigned long	PropagateRequestedRegion (const std::string &key, ImageBaseType::RegionType region, unsigned int idx=0)

void	SaveParametersToXML (const std::string &filename)

void	SetDefaultOutputComplexPixelType (std::string const &parameter, ComplexImagePixelType type)

void	SetDefaultOutputPixelType (std::string const &parameter, ImagePixelType type)

void	SetDefaultParameterDouble (std::string const &parameter, double value)

void	SetDefaultParameterFloat (std::string const &parameter, float value)

void	SetDefaultParameterInt (std::string const &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 const &parameter, bool status)

void	SetLogger (otb::Logger *logger)

void	SetMaximumParameterDoubleValue (std::string const &parameter, double value)

void	SetMaximumParameterFloatValue (std::string const &parameter, float value)

void	SetMaximumParameterIntValue (std::string const &parameter, int value)

void	SetMinimumParameterDoubleValue (std::string const &parameter, double value)

void	SetMinimumParameterFloatValue (std::string const &parameter, float value)

void	SetMinimumParameterIntValue (std::string const &parameter, int value)

virtual void	SetName (const std::string &)

void	SetNthParameterInputImageList (std::string const &parameter, const unsigned int &id, ImageBaseType *img)

void	SetNthParameterStringList (std::string const &parameter, const unsigned int &id, const std::string &str)

void	SetOfficialDocLink ()

void	SetParameterDescription (std::string const &paramKey, std::string dec)

void	SetParameterDouble (std::string const &parameter, double value, bool hasUserValueFlag=true)

void	SetParameterFloat (std::string const &parameter, float value, bool hasUserValueFlag=true)

void	SetParameterInputImage (std::string const &parameter, ImageBaseType *inputImage)

void	SetParameterInt (std::string const &parameter, int value, bool hasUserValueFlag=true)

void	SetParameterList (ParameterGroup::Pointer paramGroup)

void	SetParameterOutputImage (std::string const &parameter, FloatVectorImageType *value)

void	SetParameterOutputImagePixelType (std::string const &parameter, ImagePixelType pixelType)

void	SetParameterOutputVectorData (std::string const &parameter, VectorDataType *value)

void	SetParameterString (std::string const &parameter, std::string value, bool hasUserValueFlag=true)

void	SetParameterStringList (std::string const &parameter, std::vector< std::string > values, bool hasUserValueFlag=true)

void	SetParameterUserValue (std::string const &paramKey, bool value)

void	SetRasterData (std::string const &key, std::string const &rasterData)

void	SetTypeFilter (std::string const &key, FieldParameter::TypeFilterType const &typeFilter)

void	SetVectorData (std::string const &key, std::string const &vectorData)

void	Stop ()

void	UpdateParameters ()

void	WriteOutput ()

ImageMetadata &	GetImageMetadata (const std::string &key, unsigned int idx=0)

void	SetImageMetadata (const ImageMetadata &imd, const std::string &key, unsigned int idx=0)

itk::MetaDataDictionary	GetMetadataDictionary (const std::string &key, unsigned int idx=0)

ImagePixelType	GetImageBasePixelType (const std::string &key, unsigned int idx=0)

ImageBaseType *	GetParameterImageBase (const std::string &key, unsigned int idx=0)

void	SetParameterImageBase (const std::string &key, ImageBaseType *img, unsigned int idx=0)

void	RegisterPipeline ()

void	FreeResources ()

bool	IsExecuteDone ()

bool	IsMultiWritingEnabled ()

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

	~Application () override

void	AddProcess (itk::ProcessObject *object, std::string description)

void	AddChoice (std::string const &paramKey, std::string const &paramName)

void	AddParameter (ParameterType type, std::string const &paramKey, std::string const &paramName)

void	AddRAMParameter (std::string const &paramKey="ram")

void	AddRAMParameter (std::string const &paramKey, std::string const &paramName, unsigned int defaultValue)

void	AddRANDParameter (std::string const &paramKey="rand")

void	AddRANDParameter (std::string const &paramKey, std::string const &paramName, unsigned int defaultValue)

void	ClearChoices (std::string const &key)

std::vector< int >	GetSelectedItems (std::string const &paramKey)

void	MandatoryOn (std::string const &paramKey)

void	MandatoryOff (std::string const &paramKey)

void	SetParameterUserLevel (std::string const &paramKey, UserLevel level)

void	SetParameterRole (std::string const &paramKey, Role role)

template<class TImageType >
TImageType *	GetParameterImage (std::string const &parameter)

void	AutomaticValueOn (std::string const &paramKey)

void	AutomaticValueOff (std::string const &paramKey)

template<class TImageType >
void	SetParameterOutputImage (std::string const &parameter, TImageType *value)

virtual void	SetMultiWriting (bool _arg)

void	EnableInPrivateDo ()

void	DisableInPrivateDo ()

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)

Detailed Description

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

Definition at line 70 of file otbTrainDimensionalityReductionApplicationBase.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputValue , class TOutputValue >

typedef itk::SmartPointer<const Self> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ConstPointer

Definition at line 77 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ InputValueType

template<class TInputValue , class TOutputValue >

typedef TInputValue otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::InputValueType

Definition at line 80 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ ListSampleType

template<class TInputValue , class TOutputValue >

typedef ModelType::InputListSampleType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ListSampleType

Definition at line 93 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ ModelFactoryType

template<class TInputValue , class TOutputValue >

typedef otb::DimensionalityReductionModelFactory<InputValueType, OutputValueType> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelFactoryType

Definition at line 88 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ ModelPointerType

template<class TInputValue , class TOutputValue >

typedef ModelFactoryType::DimensionalityReductionModelTypePointer otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelPointerType

Definition at line 89 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ ModelType

template<class TInputValue , class TOutputValue >

typedef ModelFactoryType::DimensionalityReductionModelType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::ModelType

Definition at line 90 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ OutputValueType

template<class TInputValue , class TOutputValue >

typedef TOutputValue otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::OutputValueType

Definition at line 83 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ PixelType

template<class TInputValue , class TOutputValue >

typedef SampleImageType::PixelType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::PixelType

Definition at line 86 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ Pointer

template<class TInputValue , class TOutputValue >

typedef itk::SmartPointer<Self> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Pointer

Definition at line 76 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ SampleImageType

template<class TInputValue , class TOutputValue >

typedef otb::VectorImage<InputValueType> otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::SampleImageType

Definition at line 85 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ SampleType

template<class TInputValue , class TOutputValue >

typedef ModelType::InputSampleType otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::SampleType

Definition at line 92 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ Self

template<class TInputValue , class TOutputValue >

typedef TrainDimensionalityReductionApplicationBase otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::Self

Standard class typedefs.

Definition at line 74 of file otbTrainDimensionalityReductionApplicationBase.h.

◆ Superclass

template<class TInputValue , class TOutputValue >

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

Definition at line 75 of file otbTrainDimensionalityReductionApplicationBase.h.

Constructor & Destructor Documentation

◆ TrainDimensionalityReductionApplicationBase()

template<class TInputValue , class TOutputValue >

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

protected

Definition at line 31 of file otbTrainDimensionalityReductionApplicationBase.hxx.

◆ ~TrainDimensionalityReductionApplicationBase()

template<class TInputValue , class TOutputValue >

otb::Wrapper::TrainDimensionalityReductionApplicationBase< TInputValue, TOutputValue >::~TrainDimensionalityReductionApplicationBase

overrideprotected

Definition at line 36 of file otbTrainDimensionalityReductionApplicationBase.hxx.

Member Function Documentation

◆ BeforeTrainSOM()

template<class TInputValue , class TOutputValue >

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

private

Definition at line 80 of file otbDimensionalityReductionTrainSOM.hxx.

References otbAppLogFATAL.

◆ DoInit()

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 42 of file otbTrainDimensionalityReductionApplicationBase.hxx.

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

◆ GetNameOfClass()

template<class TInputValue , class TOutputValue >

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

virtual

Standard macro

Reimplemented from otb::Wrapper::Application.

◆ InitSOMParams()

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 31 of file otbDimensionalityReductionTrainSOM.hxx.

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

◆ Reduce()

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 61 of file otbTrainDimensionalityReductionApplicationBase.hxx.

◆ Train()

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 67 of file otbTrainDimensionalityReductionApplicationBase.hxx.

References otbAppLogFATAL.

◆ TrainSOM()

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 117 of file otbDimensionalityReductionTrainSOM.hxx.

References otbAppLogFATAL.

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ InputValueType

◆ ListSampleType

◆ ModelFactoryType

◆ ModelPointerType

◆ ModelType

◆ OutputValueType

◆ PixelType

◆ Pointer

◆ SampleImageType

◆ SampleType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ TrainDimensionalityReductionApplicationBase()

◆ ~TrainDimensionalityReductionApplicationBase()

Member Function Documentation

◆ BeforeTrainSOM()

◆ DoInit()

◆ GetNameOfClass()

◆ InitSOMParams()

◆ Reduce()

◆ Train()

◆ TrainSOM()

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