#include <otbTrainImagesBase.h>

Inheritance diagram for otb::Wrapper::TrainImagesBase:

Collaboration diagram for otb::Wrapper::TrainImagesBase:

Classes
struct	SamplingRates

class	TrainFileNamesHandler

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef otb::SamplingRateCalculator::MapRateType	MapRateType

typedef otb::OGRDataToSamplePositionFilter< FloatVectorImageType, UInt8ImageType, otb::PeriodicSampler >	PeriodicSamplerType

typedef itk::SmartPointer< Self >	Pointer

typedef TrainImagesBase	Self

typedef CompositeApplication	Superclass

Public Types inherited from otb::Wrapper::CompositeApplication
typedef itk::MemberCommand< Self >	AddProcessCommandType

typedef itk::SmartPointer< const Self >	ConstPointer

typedef std::map< std::string, InternalApplication >	InternalAppContainer

typedef itk::SmartPointer< Self >	Pointer

typedef CompositeApplication	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	FreeRessources ()

bool	IsExecuteDone ()

bool	IsMultiWritingEnabled ()

Protected Types
enum	SamplingStrategy { CLASS, GEOMETRIC }

Protected Member Functions
SamplingRates	ComputeFinalMaximumSamplingRates (bool dedicatedValidation)

void	ComputePolygonStatistics (FloatVectorImageListType *imageList, const std::vector< std::string > &vectorFileNames, const std::vector< std::string > &statisticsFileNames)

void	ComputeSamplingRate (const std::vector< std::string > &statisticsFileNames, const std::string &ratesFileName, long maximum)

void	ConnectClassificationParams ()

void	ConnectSamplingParameters ()

void	InitClassification ()

void	InitIO ()

void	InitSampling ()

void	SelectAndExtractSamples (FloatVectorImageType *image, std::string vectorFileName, std::string sampleFileName, std::string statisticsFileName, std::string ratesFileName, SamplingStrategy strategy, std::string selectedField="")

void	SelectAndExtractTrainSamples (const TrainFileNamesHandler &fileNames, FloatVectorImageListType *imageList, std::vector< std::string > vectorFileNames, SamplingStrategy strategy, std::string selectedFieldName="")

void	SelectAndExtractValidationSamples (const TrainFileNamesHandler &fileNames, FloatVectorImageListType *imageList, const std::vector< std::string > &validationVectorFileList=std::vector< std::string >())

void	ShareClassificationParams ()

void	ShareSamplingParameters ()

void	SplitTrainingToValidationSamples (const TrainFileNamesHandler &fileNames, FloatVectorImageListType *imageList)

void	TrainModel (FloatVectorImageListType *imageList, const std::vector< std::string > &sampleTrainFileNames, const std::vector< std::string > &sampleValidationFileNames)

Protected Member Functions inherited from otb::Wrapper::CompositeApplication
bool	AddApplication (std::string appType, std::string key, std::string desc)

void	ClearApplications ()

	CompositeApplication ()

bool	Connect (std::string fromKey, std::string toKey)

Application *	DecodeKey (std::string &key)

void	ExecuteInternal (std::string key)

std::string	GetInternalAppDescription (std::string id)

Application *	GetInternalApplication (std::string id)

void	LinkWatchers (itk::Object *, const itk::EventObject &event)

bool	ShareParameter (std::string localKey, std::string internalKey, std::string name=std::string(), std::string desc=std::string())

void	UpdateInternalParameters (std::string key)

	~CompositeApplication () 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	SplitTrainingAndValidationSamples (FloatVectorImageType *image, std::string sampleFileName, std::string sampleTrainFileName, std::string sampleValidFileName, std::string ratesTrainFileName)

Detailed Description

Base class for the TrainImagesClassifier.

This class intends to hold common input/output parameters and composite application connection for both supervised and unsupervised model training.

Definition at line 47 of file otbTrainImagesBase.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::Wrapper::TrainImagesBase::ConstPointer

Definition at line 54 of file otbTrainImagesBase.h.

◆ MapRateType

typedef otb::SamplingRateCalculator::MapRateType otb::Wrapper::TrainImagesBase::MapRateType

Definition at line 62 of file otbTrainImagesBase.h.

◆ PeriodicSamplerType

typedef otb::OGRDataToSamplePositionFilter<FloatVectorImageType, UInt8ImageType, otb::PeriodicSampler> otb::Wrapper::TrainImagesBase::PeriodicSamplerType

filters typedefs

Definition at line 57 of file otbTrainImagesBase.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::Wrapper::TrainImagesBase::Pointer

Definition at line 53 of file otbTrainImagesBase.h.

◆ Self

typedef TrainImagesBase otb::Wrapper::TrainImagesBase::Self

Standard class typedefs.

Definition at line 51 of file otbTrainImagesBase.h.

◆ Superclass

typedef CompositeApplication otb::Wrapper::TrainImagesBase::Superclass

Definition at line 52 of file otbTrainImagesBase.h.

Member Enumeration Documentation

◆ SamplingStrategy

enum otb::Wrapper::TrainImagesBase::SamplingStrategy

protected

Enumerator
CLASS
GEOMETRIC

Definition at line 65 of file otbTrainImagesBase.h.

Member Function Documentation

◆ ComputeFinalMaximumSamplingRates()

TrainImagesBase::SamplingRates otb::Wrapper::TrainImagesBase::ComputeFinalMaximumSamplingRates ( bool dedicatedValidation )

protected

Compute final maximum training and validation

Parameters

dedicatedValidation

Returns: SamplingRates final maximum training and final maximum validation

Definition at line 169 of file otbTrainImagesBase.hxx.

References otb::Wrapper::TrainImagesBase::SamplingRates::fmt, otb::Wrapper::TrainImagesBase::SamplingRates::fmv, otb::Wrapper::CompositeApplication::GetInternalApplication(), otb::Wrapper::Application::GetParameterFloat(), otb::Wrapper::Application::GetParameterInt(), and otb::Wrapper::Application::SetParameterString().

◆ ComputePolygonStatistics()

void otb::Wrapper::TrainImagesBase::ComputePolygonStatistics	(	FloatVectorImageListType *	imageList,
		const std::vector< std::string > &	vectorFileNames,
		const std::vector< std::string > &	statisticsFileNames
	)

protected

Compute polygon statistics given provided strategy with PolygonClassStatistics class

Parameters

imageList	list of input images
vectorFileNames	list of input vector file names
statisticsFileNames	list of out

Definition at line 155 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::ExecuteInternal(), otb::Wrapper::CompositeApplication::GetInternalApplication(), otb::ObjectList< TObject >::GetNthElement(), otb::Wrapper::Application::SetParameterInputImage(), otb::Wrapper::Application::SetParameterString(), and otb::ObjectList< TObject >::Size().

◆ ComputeSamplingRate()

void otb::Wrapper::TrainImagesBase::ComputeSamplingRate	(	const std::vector< std::string > &	statisticsFileNames,
		const std::string &	ratesFileName,
		long	maximum
	)

protected

Compute rates using MultiImageSamplingRate application

Parameters

statisticsFileNames
ratesFileName
maximum	final maximum value computed by ComputeFinalMaximumSamplingRates

See also: ComputeFinalMaximumSamplingRates

Definition at line 222 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::ExecuteInternal(), otb::Wrapper::CompositeApplication::GetInternalApplication(), otb::Wrapper::Application::GetParameterInt(), otb::Wrapper::Application::SetParameterString(), and otb::Wrapper::Application::SetParameterStringList().

◆ ConnectClassificationParams()

void otb::Wrapper::TrainImagesBase::ConnectClassificationParams ( )

protected

Definition at line 150 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::Connect().

Referenced by InitClassification().

◆ ConnectSamplingParameters()

void otb::Wrapper::TrainImagesBase::ConnectSamplingParameters ( )

protected

Definition at line 111 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::Connect().

Referenced by InitSampling().

◆ GetNameOfClass()

virtual const char* otb::Wrapper::TrainImagesBase::GetNameOfClass ( ) const

virtual

Standard macro

Reimplemented from otb::Wrapper::CompositeApplication.

◆ InitClassification()

void otb::Wrapper::TrainImagesBase::InitClassification ( )

protected

Definition at line 127 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::AddApplication(), otb::Wrapper::Application::AddParameter(), ConnectClassificationParams(), otb::Wrapper::Application::MandatoryOff(), otb::Wrapper::ParameterType_InputVectorDataList, otb::Wrapper::Application::SetParameterDescription(), and ShareClassificationParams().

◆ InitIO()

void otb::Wrapper::TrainImagesBase::InitIO ( )

protected

Initialize all the input and output parameter used for the train images

Definition at line 30 of file otbTrainImagesBase.hxx.

References otb::Wrapper::Application::AddParameter(), otb::Wrapper::Application::MandatoryOn(), otb::Wrapper::ParameterType_Bool, otb::Wrapper::ParameterType_Group, otb::Wrapper::ParameterType_InputImageList, otb::Wrapper::ParameterType_InputVectorDataList, otb::Wrapper::Application::SetParameterDescription(), and otb::Wrapper::Application::SetParameterInt().

◆ InitSampling()

void otb::Wrapper::TrainImagesBase::InitSampling ( )

protected

Initialize sampling related application and parameters

Definition at line 47 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::AddApplication(), otb::Wrapper::Application::AddParameter(), ConnectSamplingParameters(), otb::Wrapper::ParameterType_Float, otb::Wrapper::ParameterType_Group, otb::Wrapper::ParameterType_Int, otb::Wrapper::Application::SetDefaultParameterInt(), otb::Wrapper::Application::SetMaximumParameterFloatValue(), otb::Wrapper::Application::SetMinimumParameterFloatValue(), otb::Wrapper::Application::SetParameterDescription(), otb::Wrapper::Application::SetParameterFloat(), and ShareSamplingParameters().

◆ SelectAndExtractSamples()

void otb::Wrapper::TrainImagesBase::SelectAndExtractSamples	(	FloatVectorImageType *	image,
		std::string	vectorFileName,
		std::string	sampleFileName,
		std::string	statisticsFileName,
		std::string	ratesFileName,
		SamplingStrategy	strategy,
		std::string	selectedField = `""`
	)

protected

Select samples by class or by geographic strategy

Parameters

image
vectorFileName
sampleFileName
statisticsFileName
ratesFileName
strategy

Definition at line 276 of file otbTrainImagesBase.hxx.

References CLASS, otb::Wrapper::CompositeApplication::ExecuteInternal(), otb::Wrapper::CompositeApplication::GetInternalApplication(), otb::Wrapper::Application::SetParameterInputImage(), otb::Wrapper::Application::SetParameterInt(), otb::Wrapper::Application::SetParameterString(), and otb::Wrapper::CompositeApplication::UpdateInternalParameters().

Referenced by SelectAndExtractTrainSamples(), and SelectAndExtractValidationSamples().

◆ SelectAndExtractTrainSamples()

void otb::Wrapper::TrainImagesBase::SelectAndExtractTrainSamples	(	const TrainFileNamesHandler &	fileNames,
		FloatVectorImageListType *	imageList,
		std::vector< std::string >	vectorFileNames,
		SamplingStrategy	strategy,
		std::string	selectedFieldName = `""`
	)

protected

Select and extract samples with the SampleSelection and SampleExtraction application.

Parameters

fileNames
imageList
vectorFileNames
strategy	the strategy used for selection (by class or with geometry)
selectedFieldName

Definition at line 318 of file otbTrainImagesBase.hxx.

References otb::ObjectList< TObject >::GetNthElement(), otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::polyStatTrainOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::ratesTrainOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::sampleOutputs, SelectAndExtractSamples(), and otb::ObjectList< TObject >::Size().

◆ SelectAndExtractValidationSamples()

void otb::Wrapper::TrainImagesBase::SelectAndExtractValidationSamples	(	const TrainFileNamesHandler &	fileNames,
		FloatVectorImageListType *	imageList,
		const std::vector< std::string > &	validationVectorFileList = `std::vector<std::string>()`
	)

protected

Function used to select validation samples based on a defined strategy (geometric in unsupervised mode) and extract them. With dedicated validation the 'by class' sampling strategy and statistics are used. Otherwise this function split training to validation samples corresponding to sample.vtr percentage. or do nothing if this percentage is == 0

Parameters

fileNames
imageList
validationVectorFileList	optional validation vector file for each images

Definition at line 331 of file otbTrainImagesBase.hxx.

References CLASS, otb::ObjectList< TObject >::GetNthElement(), otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::polyStatValidOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::ratesValidOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::sampleValidOutputs, SelectAndExtractSamples(), and otb::ObjectList< TObject >::Size().

◆ ShareClassificationParams()

void otb::Wrapper::TrainImagesBase::ShareClassificationParams ( )

protected

Definition at line 139 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::ShareParameter().

Referenced by InitClassification().

◆ ShareSamplingParameters()

void otb::Wrapper::TrainImagesBase::ShareSamplingParameters ( )

protected

Definition at line 98 of file otbTrainImagesBase.hxx.

References otb::Wrapper::Application::SetVectorData(), and otb::Wrapper::CompositeApplication::ShareParameter().

Referenced by InitSampling().

◆ SplitTrainingAndValidationSamples()

void otb::Wrapper::TrainImagesBase::SplitTrainingAndValidationSamples	(	FloatVectorImageType *	image,
		std::string	sampleFileName,
		std::string	sampleTrainFileName,
		std::string	sampleValidFileName,
		std::string	ratesTrainFileName
	)

private

Function used to split training samples in set of training and validation.

Parameters

image	input image
sampleFileName	the input sample file name
sampleTrainFileName	the input training file name
sampleValidFileName	the input validation file name
ratesTrainFileName	the rates file name

Definition at line 350 of file otbTrainImagesBase.hxx.

References otb::Wrapper::Application::AddProcess(), otb::Wrapper::Application::GetParameterFloat(), otb::Wrapper::Application::GetParameterInt(), otb::Wrapper::Application::GetParameterStringList(), otb::SamplingRateCalculator::New(), otb::ogr::DataSource::New(), otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::New(), otb::ogr::DataSource::Modes::Overwrite, and otb::ogr::DataSource::Modes::Read.

Referenced by SplitTrainingToValidationSamples().

◆ SplitTrainingToValidationSamples()

void otb::Wrapper::TrainImagesBase::SplitTrainingToValidationSamples	(	const TrainFileNamesHandler &	fileNames,
		FloatVectorImageListType *	imageList
	)

protected

Function used to split all training samples from all images in a set of training and validation.

Parameters

fileNames
imageList

See also: SplitTrainingAndValidationSamples

Definition at line 341 of file otbTrainImagesBase.hxx.

References otb::ObjectList< TObject >::GetNthElement(), otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::ratesTrainOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::sampleOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::sampleTrainOutputs, otb::Wrapper::TrainImagesBase::TrainFileNamesHandler::sampleValidOutputs, otb::ObjectList< TObject >::Size(), and SplitTrainingAndValidationSamples().

◆ TrainModel()

void otb::Wrapper::TrainImagesBase::TrainModel	(	FloatVectorImageListType *	imageList,
		const std::vector< std::string > &	sampleTrainFileNames,
		const std::vector< std::string > &	sampleValidationFileNames
	)

protected

Train the model with training and optional validation data samples

Parameters

imageList	list of input images
sampleTrainFileNames	files names of the training samples
sampleValidationFileNames	file names of the validation sample

Definition at line 248 of file otbTrainImagesBase.hxx.

References otb::Wrapper::CompositeApplication::ExecuteInternal(), otb::Wrapper::Application::GetChoiceNames(), otb::Wrapper::CompositeApplication::GetInternalApplication(), otb::ObjectList< TObject >::GetNthElement(), otb::Wrapper::Application::GetSelectedItems(), otb::Wrapper::Application::SetParameterStringList(), and otb::Wrapper::CompositeApplication::UpdateInternalParameters().

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

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ MapRateType

◆ PeriodicSamplerType

◆ Pointer

◆ Self

◆ Superclass

Member Enumeration Documentation

◆ SamplingStrategy

Member Function Documentation

◆ ComputeFinalMaximumSamplingRates()

◆ ComputePolygonStatistics()

◆ ComputeSamplingRate()

◆ ConnectClassificationParams()

◆ ConnectSamplingParameters()

◆ GetNameOfClass()

◆ InitClassification()

◆ InitIO()

◆ InitSampling()

◆ SelectAndExtractSamples()

◆ SelectAndExtractTrainSamples()

◆ SelectAndExtractValidationSamples()

◆ ShareClassificationParams()

◆ ShareSamplingParameters()

◆ SplitTrainingAndValidationSamples()

◆ SplitTrainingToValidationSamples()

◆ TrainModel()