This is the namespace for the Statistics module. More...

Classes
class	Module
	This singleton defines the TerraLib Qt Widgets module entry. More...

struct	NumericStatisticalSummary
	A structure to hold the set of statistics from a set of numerical values. More...

class	StatisticsDialog

struct	StringStatisticalSummary
	A structure to hold the set of statistics from a set of categorical (sample) values. More...

Enumerations
enum	StatisticalSummary { MIN_VALUE, MAX_VALUE, MEAN, SUM, COUNT, VALID_COUNT, STANDARD_DEVIATION, VARIANCE, SKEWNESS, KURTOSIS, AMPLITUDE, MEDIAN, VAR_COEFF, MODE, PERCENT_EACH_CLASS_BY_AREA, PERCENT_TOTAL_AREA }
	Define grouping functions type. More...

Functions
TESTATEXPORT std::vector< double >	GetNumericData (te::da::DataSet *dataSet, const std::string propName)
	Returns the values of a numeric type property in a vector of values. More...

TESTATEXPORT void	GetNumericStatisticalSummary (std::vector< double > &values, te::stat::NumericStatisticalSummary &ss, double nullVal)

TESTATEXPORT void	GetNumericStatisticalSummary (std::vector< double > &values, te::stat::NumericStatisticalSummary &ss)

TESTATEXPORT void	GetNumericStatisticalSummaryQuery (const std::string &inDataset, te::da::DataSource *inDatasource, const std::string &propName, te::stat::NumericStatisticalSummary &ss)

TESTATEXPORT void	GetPercentOfEachClassByArea (std::vector< double > &values, double &resolutionX, double &resolutionY, double &area, te::stat::NumericStatisticalSummary &ss, bool fullIntersection=true)

TESTATEXPORT std::string	GetStatSummaryFullName (const int &e)
	Get the statistical parameter full name ffrom its enumerator. More...

TESTATEXPORT std::string	GetStatSummaryShortName (const int &e)
	Get the statistical parameter short name from its enumerator. More...

TESTATEXPORT std::vector< std::string >	GetStringData (te::da::DataSet *dataSet, const std::string propName)
	Returns the values of a string type property in a vector of values. More...

TESTATEXPORT void	GetStringStatisticalSummary (std::vector< std::string > &values, te::stat::StringStatisticalSummary &ss)

TESTATEXPORT void	GetStringStatisticalSummary (std::vector< std::string > &values, te::stat::StringStatisticalSummary &ss, const std::string &nullValue)

TESTATEXPORT void	GetStringStatisticalSummaryQuery (const std::string &inDataset, te::da::DataSource *inDatasource, const std::string &propName, te::stat::StringStatisticalSummary &ss)

TESTATEXPORT void	Mode (const std::vector< double > &values, te::stat::NumericStatisticalSummary &ss)

TESTATEXPORT void	Mode (const std::vector< std::string > &values, te::stat::StringStatisticalSummary &ss)

Detailed Description

This is the namespace for the Statistics module.

Enumeration Type Documentation

enum te::stat::StatisticalSummary

Define grouping functions type.

enum StatisticalSummary { MIN_VALUE, //!< Minimum value. MAX_VALUE, //!< Maximum value. MEAN, //!< Mean. SUM, //!< Sum of values. COUNT, //!< Total number of values. VALID_COUNT, //!< Total not null values. STANDARD_DEVIATION, //!< Standard deviation. VARIANCE, //!< Variance. SKEWNESS, //!< Skewness. KURTOSIS, //!< Kurtosis. AMPLITUDE, //!< Amplitude. MEDIAN, //!< Median. VAR_COEFF, //!< Coefficient variation. MODE //!< Mode. };

Enumerator
MIN_VALUE	Minimum value.
MAX_VALUE	Maximum value.
MEAN	Mean.
SUM	Sum of values.
COUNT	Total number of values.
VALID_COUNT	Total not null values.
STANDARD_DEVIATION	Standard deviation.
VARIANCE	Variance.
SKEWNESS	Skewness.
KURTOSIS	Kurtosis.
AMPLITUDE	Amplitude.
MEDIAN	Median.
VAR_COEFF	Coefficient variation.
MODE	Mode.
PERCENT_EACH_CLASS_BY_AREA	Percente of each class by area.
PERCENT_TOTAL_AREA	Percente of total area.

Definition at line 39 of file Enums.h.

Function Documentation

TESTATEXPORT std::vector<double> te::stat::GetNumericData	(	te::da::DataSet *	dataSet,
		const std::string	propName
	)

Returns the values of a numeric type property in a vector of values.

It returns only the non-empty values.

Parameters

dataSet	A pointer to the dataset. Do not pass null.
propName	The propoerty name. Do not pass empty.

Returns: The vector of numeric values (double).

TESTATEXPORT void te::stat::GetNumericStatisticalSummary	(	std::vector< double > &	values,
		te::stat::NumericStatisticalSummary &	ss,
		double	nullVal
	)

Fills the summary statistics structure from a set of numerical values.

Parameters

values	a vector of numerical values. Do not pass empty.
ss	to return the statistical summary.
nullVal	a value to be considered as non-value or invalid value.

TESTATEXPORT void te::stat::GetNumericStatisticalSummary	(	std::vector< double > &	values,
		te::stat::NumericStatisticalSummary &	ss
	)

Fills the summary statistics structure from a set of numerical values.

Parameters

values	a vector of numerical values. Do not pass empty.
ss	to return the statistical summary.

TESTATEXPORT void te::stat::GetNumericStatisticalSummaryQuery	(	const std::string &	inDataset,
		te::da::DataSource *	inDatasource,
		const std::string &	propName,
		te::stat::NumericStatisticalSummary &	ss
	)

Fills the summary statistics structure of a given numerical property from a dataset.

Parameters

inDataset	a dataset name.
inDatasource	a pointer to a datasource. Do not pass null.
propName	the name of the property to be summarized.
ss	to return the statistical summary.

TESTATEXPORT void te::stat::GetPercentOfEachClassByArea	(	std::vector< double > &	values,
		double &	resolutionX,
		double &	resolutionY,
		double &	area,
		te::stat::NumericStatisticalSummary &	ss,
		bool	fullIntersection = `true`
	)

Fills the percentage of each class by area.

Parameters

values	a vector of numerical values, representing pixels from a raster. Do not pass empty.
resolutionX	a raster horizontal (x-axis) resolution.
resolutionY	a raster vertical (y-axis) resolution.
area	area of a geometry that intersects the raster.
ss	to return the percentage of each class by area.
fullIntersection	set as true if geometry is all inside of the raster box.

TESTATEXPORT std::string te::stat::GetStatSummaryFullName ( const int & e )

Get the statistical parameter full name ffrom its enumerator.

Parameters

e	The enumerator.

Returns: The statistical parameter full name of enum.

TESTATEXPORT std::string te::stat::GetStatSummaryShortName ( const int & e )

Get the statistical parameter short name from its enumerator.

Parameters

e	The enumerator.

Returns: The short name for the statistical parameter.

TESTATEXPORT std::vector<std::string> te::stat::GetStringData	(	te::da::DataSet *	dataSet,
		const std::string	propName
	)

Returns the values of a string type property in a vector of values.

It returns only the non-empty values.

Parameters

dataSet	A pointer to the dataset. Do not pass null.
propName	The propoerty name. Do not pass empty.

Returns: The vector of string values.

TESTATEXPORT void te::stat::GetStringStatisticalSummary	(	std::vector< std::string > &	values,
		te::stat::StringStatisticalSummary &	ss
	)

Fills the summary statistics structure from a set of categorical values.

Parameters

values	a vector of categorical values. Do not pass empty.
ss	to return the statistical summary.

TESTATEXPORT void te::stat::GetStringStatisticalSummary	(	std::vector< std::string > &	values,
		te::stat::StringStatisticalSummary &	ss,
		const std::string &	nullValue
	)

Fills the summary statistics structure from a set of categorical values.

Parameters

values	a vector of categorical values. Do not pass empty.
ss	to return the statistical summary.
nullVal	a value to be considered as non-value or invalid value.

TESTATEXPORT void te::stat::GetStringStatisticalSummaryQuery	(	const std::string &	inDataset,
		te::da::DataSource *	inDatasource,
		const std::string &	propName,
		te::stat::StringStatisticalSummary &	ss
	)

Fills the summary statistics structure of a given categorical property from a dataset.

Parameters

inDataset	a dataset name.
inDatasource	a pointer to a datasource. Do not pass null.
propName	the name of the property to be summarized.
ss	to return the statistical summary.

TESTATEXPORT void te::stat::Mode	(	const std::vector< double > &	values,
		te::stat::NumericStatisticalSummary &	ss
	)

Returns the mode of set of numerical values.

Parameters

values	a reference to a set of numerical values. Do not pass empty.
ss	to return the mode (most frequent value).

TESTATEXPORT void te::stat::Mode	(	const std::vector< std::string > &	values,
		te::stat::StringStatisticalSummary &	ss
	)

Returns the mode of set of categorical values.

Parameters

values	a reference to a set of categorical values;
ss	to return the mode (most frequent value).

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation