com.rapidminer.operator.performance
Class SquaredCorrelationCriterion

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.tools.math.Averagable
              com.rapidminer.operator.performance.PerformanceCriterion
                  com.rapidminer.operator.performance.MeasuredPerformance
                      com.rapidminer.operator.performance.CorrelationCriterion
                          com.rapidminer.operator.performance.SquaredCorrelationCriterion

All Implemented Interfaces:

IOObject, ResultObject, Readable, Reportable, LoggingHandler, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<PerformanceCriterion>

public class SquaredCorrelationCriterion
extends CorrelationCriterion

Computes the square of the empirical corellation coefficient 'r' between label and prediction. Eith P=prediction, L=label, V=Variance, Cov=Covariance we calculate r by:
Cov(L,P) / sqrt(V(L)*V(P)). Uses the calculation of the superclass.

Author:

Ingo Mierswa ingomierswa Exp $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.rapidminer.operator.AbstractIOObject

AbstractIOObject.InputStreamProvider

Constructor Summary

SquaredCorrelationCriterion()

Method Summary

java.lang.String	getDescription() Returns a description of the performance criterion.
double	getMikroAverage() Returns the (current) value of the averagable (the average itself).
java.lang.String	getName() Returns the name of this averagable.

Methods inherited from class com.rapidminer.operator.performance.CorrelationCriterion

buildSingleAverage, countExample, getExampleCount, getFitness, getMaxFitness, getMikroVariance, startCounting

Methods inherited from class com.rapidminer.operator.performance.MeasuredPerformance

startCounting

Methods inherited from class com.rapidminer.operator.performance.PerformanceCriterion

compareTo

Methods inherited from class com.rapidminer.tools.math.Averagable

buildAverage, clone, cloneAveragable, formatPercent, getAverage, getAverageCount, getExtension, getFileDescription, getMakroAverage, getMakroStandardDeviation, getMakroVariance, getMikroStandardDeviation, getStandardDeviation, getVariance, isInTargetEncoding, setAverageCount, toString

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, getAnnotations, getResultIcon, log, log, logError, logNote, logWarning, toHTML, toResultString

Methods inherited from class com.rapidminer.operator.AbstractIOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, initWriting, read, read, read, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rapidminer.operator.IOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, setLoggingHandler, setSource, write

Constructor Detail

SquaredCorrelationCriterion

public SquaredCorrelationCriterion()

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from class: PerformanceCriterion

Returns a description of the performance criterion. This description is used for GUI purposes and automatic parameter type creation for the PerformanceEvaluator operator.

Overrides:

getDescription in class CorrelationCriterion

getMikroAverage

public double getMikroAverage()

Description copied from class: Averagable

Returns the (current) value of the averagable (the average itself). If the method Averagable.buildSingleAverage(Averagable) was used, this method must return the micro average from both (or more) criteria. This is usually achieved by correctly implementing Averagable.buildSingleAverage(Averagable).

Overrides:

getMikroAverage in class CorrelationCriterion

getName

public java.lang.String getName()

Description copied from class: Averagable

Returns the name of this averagable. The returned string should only contain lowercase letters and underscore (RapidMiner parameter format) since the names will be automatically used for GUI purposes.

Specified by:

getName in interface ResultObject

Overrides:

getName in class CorrelationCriterion