TOBI iC classifier. More...

#include <tobiic/ICClassifier.hpp>

Collaboration diagram for ICClassifier:

Public Member Functions
	ICClassifier (const std::string &name, const std::string &desc)
	Constructor.
	ICClassifier (const std::string &name, const std::string &desc, ICVtype vtype, ICLtype ltype)
	Constructor.
virtual std::string	GetName (void) const
	Classifier name getter.
virtual std::string	GetDescription (void) const
	Classifier description getter.
virtual const char *	GetChName (void)
	Classifier name getter (as char array)
virtual const char *	GetChDescription (void)
	Classifier description getter (as char array)
virtual bool	SetValueType (ICVtype vtype)
	Value type setter.
virtual bool	SetLabelType (ICLtype ltype)
	Label type setter.
virtual bool	SetValueType (std::string vtype)
	Value type setter.
virtual bool	SetLabelType (std::string ltype)
	Label type setter.
virtual ICVtype	GetValueType (void) const
	Value type getter.
virtual ICLtype	GetLabelType (void) const
	Label type getter.

Static Public Member Functions
static ICVtype	ValueType (const std::string &vtype)
	Converts a value type.
static ICLtype	LabelType (const std::string &ltype)
	Converts a label type.
static ICVtype	ValueChType (const char *vtype)
	Converts a value type.
static ICLtype	LabelChType (const char *ltype)
	Converts a label type.

Public Attributes
ICSetClass	classes
	ICClass map.

Static Public Attributes
static const ICVtype	ValueUndef = -1
	Undefined class value type.
static const ICVtype	ValueProb = 0
	Probabilities value type.
static const ICVtype	ValueDist = 1
	Distances value type.
static const ICVtype	ValueCLbl = 2
	Class Labels value type.
static const ICVtype	ValueRCoe = 3
	Regression coefficients value type.
static const ICLtype	LabelUndef = -1
	Undefined class label type.
static const ICLtype	LabelBiosig = 0
	Biosig label type.
static const ICLtype	LabelCustom = 1
	Custom label type.
static const ICLtype	LabelClass = 2
	Class name label type.
static std::string	TxtValueUndef
	Undefined class value type as string.
static std::string	TxtValueProb
	Probabilities value type as string.
static std::string	TxtValueDist
	Distances value type as string.
static std::string	TxtValueCLbl
	Class Labels value type as string.
static std::string	TxtValueRCoe
	Regression coefficients value type as string.
static std::string	TxtLabelUndef
	Undefined class label type as string.
static std::string	TxtLabelBiosig
	Biosig label type as string.
static std::string	TxtLabelCustom
	Custom label type as string.
static std::string	TxtLabelClass
	Class name label type as string.

Protected Attributes
std::string	_name
	Classifier name.
std::string	_desc
	Classifier description.
char	_chname [ICCLASSIFIER_CHNAME_SIZE]
	Classifier name for in-situ serialization.
char	_chdesc [ICCLASSIFIER_CHDESC_SIZE]
	Classifier description for in-situ serialization.
ICVtype	_vtype
	Value type.
ICLtype	_ltype
	Label type.

Detailed Description

TOBI iC classifier.

An ICClassifier is a set of ICClass objects, stored in an ICSetClass map. Whithin the ICSetClass map, each ICClass is identified with its label (i.e. 0x756, 0x562).

Each classifier must be configured for a specific label type (i.e. Biosig) and for a particular value type (i.e. probabilities, regression coefficients).

See Also: classes

Examples:: icclassifier.cpp, icexample.cpp, icserializerrapid.cpp, and tpicclient.cpp.

Definition at line 48 of file ICClassifier.hpp.

Member Function Documentation

const char * ICClassifier::GetChDescription ( void )

virtual

Classifier description getter (as char array)

Returns: Reference to lassifier description

Definition at line 77 of file ICClassifier.cpp.

Here is the caller graph for this function:

const char * ICClassifier::GetChName ( void )

virtual

Classifier name getter (as char array)

Returns: Reference to classifier name

Definition at line 63 of file ICClassifier.cpp.

Here is the caller graph for this function:

std::string ICClassifier::GetDescription ( void ) const

virtual

Classifier description getter.

Returns: Classifier description

Definition at line 59 of file ICClassifier.cpp.

Here is the caller graph for this function:

ICLtype ICClassifier::GetLabelType ( void ) const

virtual

Label type getter.

Returns: Label type

Definition at line 140 of file ICClassifier.cpp.

Here is the caller graph for this function:

std::string ICClassifier::GetName ( void ) const

virtual

Classifier name getter.

Returns: Classifier name

Definition at line 55 of file ICClassifier.cpp.

Here is the caller graph for this function:

ICVtype ICClassifier::GetValueType ( void ) const

virtual

Value type getter.

Returns: Value type

Definition at line 136 of file ICClassifier.cpp.

Here is the caller graph for this function:

ICLtype ICClassifier::LabelChType ( const char * ltype )

static

Converts a label type.

ltype Label type as char array
Returns
Label type

Definition at line 195 of file ICClassifier.cpp.

ICLtype ICClassifier::LabelType ( const std::string & ltype )

static

Converts a label type.

ltype Label type as std::string
Returns
Label type

Definition at line 159 of file ICClassifier.cpp.

Here is the caller graph for this function:

bool ICClassifier::SetLabelType ( ICLtype ltype )

virtual

Label type setter.

ltype Label type
Returns
True if successful, false otherwise

Definition at line 98 of file ICClassifier.cpp.

bool ICClassifier::SetLabelType ( std::string ltype )

virtual

Label type setter.

ltype Label type
Returns
True if successful, false otherwise

Definition at line 121 of file ICClassifier.cpp.

bool ICClassifier::SetValueType ( ICVtype vtype )

virtual

Value type setter.

vtype Value type
Returns
True if successful, false otherwise

Definition at line 91 of file ICClassifier.cpp.

bool ICClassifier::SetValueType ( std::string vtype )

virtual

Value type setter.

vtype Value type
Returns
True if successful, false otherwise

Definition at line 105 of file ICClassifier.cpp.

ICVtype ICClassifier::ValueChType ( const char * vtype )

static

Converts a value type.

vtype Value type as char array
Returns
Value type

Definition at line 172 of file ICClassifier.cpp.

ICVtype ICClassifier::ValueType ( const std::string & vtype )

static

Converts a value type.

vtype Value type as std::string
Returns
Value type

Definition at line 144 of file ICClassifier.cpp.

Here is the caller graph for this function:

Member Data Documentation

ICSetClass ICClassifier::classes

ICClass map.

Set of ICClass objects.

Examples:: icclassifier.cpp, icexample.cpp, icserializerrapid.cpp, and tpicclient.cpp.

Definition at line 192 of file ICClassifier.hpp.

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

tobiic/ICClassifier.hpp
tobiic/ICClassifier.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation