ClassificationResult.h

Go to the documentation of this file.

/*
 GRT MIT License
 Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 and associated documentation files (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial
 portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef GRT_CLASSIFICATION_RESULT_HEADER
#define GRT_CLASSIFICATION_RESULT_HEADER
#include "GRTCommon.h"

GRT_BEGIN_NAMESPACE

class ClassificationResult{
public:
    ClassificationResult(UINT classLabel=0,UINT predictedClassLabel=0,UINT unprocessedPredictedClassLabel=0,Float maximumLikelihood=0,VectorFloat classLikelihoods=VectorDouble(),VectorFloat classDistances = VectorFloat()){
        this->classLabel = classLabel;
        this->predictedClassLabel = predictedClassLabel;
        this->unprocessedPredictedClassLabel = unprocessedPredictedClassLabel;
        this->maximumLikelihood = maximumLikelihood;
        this->classLikelihoods = classLikelihoods;
        this->classDistances = classDistances;
    }
    
    ClassificationResult(const ClassificationResult &rhs){
        this->classLabel = rhs.classLabel;
        this->predictedClassLabel = rhs.predictedClassLabel;
        this->unprocessedPredictedClassLabel = rhs.unprocessedPredictedClassLabel;
        this->maximumLikelihood = rhs.maximumLikelihood;
        this->classLikelihoods = rhs.classLikelihoods;
        this->classDistances = rhs.classDistances;
    }
    
    ~ClassificationResult(){
        
    }
    
    ClassificationResult operator=(const ClassificationResult &rhs){
        if( this != &rhs ){
            this->classLabel = rhs.classLabel;
            this->predictedClassLabel = rhs.predictedClassLabel;
            this->unprocessedPredictedClassLabel = rhs.unprocessedPredictedClassLabel;
            this->maximumLikelihood = rhs.maximumLikelihood;
            this->classLikelihoods = rhs.classLikelihoods;
            this->classDistances = rhs.classDistances;
        }
        return *this;
    }
    
    bool getCorrectPrediction() const {
        return( classLabel == predictedClassLabel);
    }
    
    UINT getClassLabel() const {
        return classLabel;
    }
    
    UINT getPredictedClassLabel() const {
        return predictedClassLabel;
    }
    
    UINT getUnprocessedPredictedClassLabel() const {
        return unprocessedPredictedClassLabel;
    }
    
    Float getMaximumLikelihood() const {
        return maximumLikelihood;
    }
    
    VectorFloat getClassLikelihoods() const {
        return classLikelihoods;
    }
    
    VectorFloat getClassDistances() const {
        return classDistances;
    }
    
    UINT classLabel;
    UINT predictedClassLabel;
    UINT unprocessedPredictedClassLabel;
    Float maximumLikelihood;
    VectorFloat classLikelihoods;
    VectorFloat classDistances;
};

GRT_END_NAMESPACE

#endif //GRT_CLASSIFICATION_RESULT_HEADER