cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters Class Reference

the parameters for the class secondOrderStatistics More...

#include <cvrSecondOrderStatistics.h>

Inheritance diagram for cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters:

[legend]

Collaboration diagram for cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
const std::string &	name () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
virtual parameters *	clone () const
virtual parameters *	newInstance () const
Public Attributes
eDataRepresentationType	dataRepresentationType
eVarianceType	varianceType
bool	useCorrelation

---

Detailed Description

template<typename T, typename U = T>
class cvr::secondOrderStatistics< T, U >::parameters

the parameters for the class secondOrderStatistics

---

Constructor & Destructor Documentation

template<typename T , typename U = T>

cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::functor::functor::parameters.

template<typename T , typename U = T>

cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

template<typename T , typename U = T>

cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

template<typename T , typename U = T>

virtual parameters* cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

template<typename T , typename U = T>

parameters& cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

template<typename T , typename U = T>

const std::string& cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::name

(

)

const [virtual]

Returns the name of this class.

Implements cvr::functor::functor::parameters.

template<typename T , typename U = T>

virtual parameters* cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::functor::functor::parameters.

template<typename T , typename U = T>

parameters& cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

template<typename T , typename U = T>

virtual bool cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also read, otherwise only the data block will be read.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

template<typename T , typename U = T>

virtual bool cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

template<typename T , typename U = T>

eDataRepresentationType cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::dataRepresentationType

The CVR-Lib usually represents a data sample as a row of a matrix.

However, by choosing Columns here, you can achieve the opposite behavior. This is not recommended since it is confusing and much slower!

Default value: Rows

template<typename T , typename U = T>

bool cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::useCorrelation

If this flag is true, the covariance matrix is normalized to contain the correlation coefficients instead of the covariances.

Default value: false

template<typename T , typename U = T>

eVarianceType cvr::secondOrderStatistics< T, U >::secondOrderStatistics::parameters::varianceType

The type of the variance computation.

If Empirical is used, the empirical variance or covariance matrix is computed (division by number of samples minus 1), otherwise, the maximum likelihood estimator is computed (division by number of samples).

Default value: Empirical

---

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

• cvrSecondOrderStatistics.h