lti::classificationStatistics::parameters Class Reference

the parameters for the class classificationStatistics More...

#include <ltiClassificationStatistics.h>

Inheritance diagram for lti::classificationStatistics::parameters:

[legend]

Collaboration diagram for lti::classificationStatistics::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	useNames
std::string	namesFile
bool	namesInFileFirst
bool	suppressZeros
bool	writeConfusionMatrix
std::string	confusionMatrix
int	saveStep
bool	useLogFile
std::string	logFile
bool	logAllPatterns
std::string	path

---

Detailed Description

the parameters for the class classificationStatistics

---

Constructor & Destructor Documentation

lti::classificationStatistics::parameters::parameters

(

)

default constructor

lti::classificationStatistics::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

virtual lti::classificationStatistics::parameters::~parameters

(

)

[virtual]

destructor

---

Member Function Documentation

virtual parameters* lti::classificationStatistics::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

parameters& lti::classificationStatistics::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

Reimplemented from lti::ioObject.

const char* lti::classificationStatistics::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::ioObject.

parameters& lti::classificationStatistics::parameters::operator=

(

const parameters &

other

)

copy data of "other" parameters

Reimplemented from lti::ioObject.

virtual bool lti::classificationStatistics::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 written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::ioObject.

virtual bool lti::classificationStatistics::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 lti::ioObject.

---

Member Data Documentation

std::string lti::classificationStatistics::parameters::confusionMatrix

name of the file, where the confusion matrix will be saved (Default value "confusion.mat").

Will be appended to parameter 'path'.

Note: only considered, if parameter writeConfusionMatrix==true.

bool lti::classificationStatistics::parameters::logAllPatterns

if true, all patterns will be registered in the log file, if false, only the errors will be registered (Default value: false).

Note: only considered, if parameter useLogFile==true.

std::string lti::classificationStatistics::parameters::logFile

name for the protocol file (Default value "logfile.txt").

Will be appended to parameter 'path'.

Note: only considered, if parameter useLogFile==true.

std::string lti::classificationStatistics::parameters::namesFile

Filename with class names.

Name of the file where the names for the objects can be found (Default value "objectNames.nms").

This name is not expected to have a path, since it will always be seached in the directory specified in 'path'. Thus, the names file will be expected at parameters::path + parameters::namesFile.

These files consist of two columns. The first containing the object ids, the second the object names in double quotes and separated by whitespaces e.g.

 314 "Circle"
 4   "Square"

Note: only considered, if parameters useNames==true. Make sure that the parameter path is also specified!

bool lti::classificationStatistics::parameters::namesInFileFirst

Names in file first.

The order of the columns in the names file can be inverted setting this parameter to true.

Set to true if each line contains name of object followed by id.

Set to false if each line contains the id followed by the object name.

Default value: false

std::string lti::classificationStatistics::parameters::path

The "path" string will be concatenated before all filenames (Default value: "", i.e.

working directory).

int lti::classificationStatistics::parameters::saveStep

specify the intervall of entries for automatic saving of the confusion-matrix (Default value: 100, i.e.

each 100 entries the confusion-mtrix will be saved automatically). Alternatively you may call flush() to force write at any moment.

Note: only considered, if parameter writeConfusionMatrix==true.

bool lti::classificationStatistics::parameters::suppressZeros

If the confusion matrix is going to be read by humans, it is usually better if "-" are used instead of zeros.

If you need other tools (like Matlab, Excel, etc.) to read the confusion matrix files, you need the zeros.

Default value: true

bool lti::classificationStatistics::parameters::useLogFile

use a protocol file, where each entry will be registered.

(Default value: true)

bool lti::classificationStatistics::parameters::useNames

Use class names in file.

If true, the ids of the objects are substituted by names given in the file specified by parameter 'namesFile' (Default value: false).

Note: this must be set to false if you intend to specify the idToNamesMap manually by calling setNames().

bool lti::classificationStatistics::parameters::writeConfusionMatrix

if true, the confusion matrix will be saved automatically in the file specified by parameter 'confusionMatrix'.

Saving intervals are defined by parameter 'saveStep' and on destruction (Default value: true).

---

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

• ltiClassificationStatistics.h