ClassificationResult Class Reference

Public Member Functions
	ClassificationResult (UINT classLabel=0, UINT predictedClassLabel=0, UINT unprocessedPredictedClassLabel=0, Float maximumLikelihood=0, VectorFloat classLikelihoods=VectorDouble(), VectorFloat classDistances=VectorFloat())
	ClassificationResult (const ClassificationResult &rhs)
	~ClassificationResult ()
ClassificationResult	operator= (const ClassificationResult &rhs)
bool	getCorrectPrediction () const
UINT	getClassLabel () const
UINT	getPredictedClassLabel () const
UINT	getUnprocessedPredictedClassLabel () const
Float	getMaximumLikelihood () const
VectorFloat	getClassLikelihoods () const
VectorFloat	getClassDistances () const

Public Attributes
UINT	classLabel
UINT	predictedClassLabel
UINT	unprocessedPredictedClassLabel
Float	maximumLikelihood
VectorFloat	classLikelihoods
VectorFloat	classDistances

Detailed Description

Definition at line 35 of file ClassificationResult.h.

Constructor & Destructor Documentation

ClassificationResult::ClassificationResult ( UINT  classLabel = 0, UINT  predictedClassLabel = 0, UINT  unprocessedPredictedClassLabel = 0, Float  maximumLikelihood = 0, VectorFloat  classLikelihoods = VectorDouble(), VectorFloat  classDistances = VectorFloat()  )

inline

Default Constructor.

Initializes the ClassificationResult instance.

Parameters

classLabel	sets the class label corresponding to this instance. Default value = 0
predictedClassLabel	sets the predicted class label corresponding to this instance. Default value = 0
unprocessedPredictedClassLabel	sets the unprocessed predicted class label corresponding to this instance. Default value = 0
maximumLikelihood	sets the maximum likelihood corresponding to this instance. Default value = 0
classLikelihoods	sets the class likelihoods corresponding to this instance. Default value = empty vector
classDistances	sets the class label corresponding to this instance. Default value = empty vector

Definition at line 49 of file ClassificationResult.h.

ClassificationResult::ClassificationResult ( const ClassificationResult &  rhs )

inline

Copy Constructor.

Initializes this instance by copying the data from the rhs instance

Parameters

rhs	another instance of the ClassificationResult class

Definition at line 65 of file ClassificationResult.h.

ClassificationResult::~ClassificationResult ( )

inline

Default Destructor.

Definition at line 77 of file ClassificationResult.h.

Member Function Documentation

VectorFloat ClassificationResult::getClassDistances ( ) const

inline

Returns the vector of class distances corresponding with this classification result.

Returns

returns the vector of class distances

Definition at line 160 of file ClassificationResult.h.

UINT ClassificationResult::getClassLabel ( ) const

inline

Returns the class label corresponding with this classification result.

Returns

returns the class label

Definition at line 113 of file ClassificationResult.h.

VectorFloat ClassificationResult::getClassLikelihoods ( ) const

inline

Returns the vector of class likelihoods corresponding with this classification result.

Returns

returns the vector of class likelihoods

Definition at line 151 of file ClassificationResult.h.

bool ClassificationResult::getCorrectPrediction ( ) const

inline

Returns true if the predicted class label matches the class label.

Returns

returns true if the predicted class label matches the class label, false otherwise

Definition at line 104 of file ClassificationResult.h.

Float ClassificationResult::getMaximumLikelihood ( ) const

inline

Returns the maximum likelihood corresponding with this classification result.

Returns

returns the maximum likelihood

Definition at line 142 of file ClassificationResult.h.

UINT ClassificationResult::getPredictedClassLabel ( ) const

inline

Returns the predicted class label corresponding with this classification result. The predicted class label is the output prediction of your pipeline.

Returns

returns the predicted class label

Definition at line 123 of file ClassificationResult.h.

UINT ClassificationResult::getUnprocessedPredictedClassLabel ( ) const

inline

Returns the unprocessed predicted class label corresponding with this classification result. The unprocessed predicted class label is the output of the classifier in your pipeline.

Returns

returns the unprocessed predicted class label

Definition at line 133 of file ClassificationResult.h.

ClassificationResult ClassificationResult::operator= ( const ClassificationResult &  rhs )

inline

Defines the equals operator

Parameters

rhs	another instance of the ClassificationResult class

Returns

returns a pointer to this instace

Definition at line 87 of file ClassificationResult.h.

---

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

• ClassificationResult.h