public class EvaluationMetricHelper
extends java.lang.Object
Constructor and Description |
---|
EvaluationMetricHelper(Evaluation eval)
Construct a new EvaluationMetricHelper
|
Modifier and Type | Method and Description |
---|---|
static java.util.List<java.lang.String> |
getAllMetricNames()
Get a list of all available evaluation metric names
|
static java.util.List<java.lang.String> |
getBuiltInMetricNames()
Get a list of built-in metric names
|
double |
getNamedMetric(java.lang.String statName,
int... classValIndex)
Gets the value of a named metric.
|
double[] |
getNamedMetricThresholds(java.lang.String statName)
Gets the thresholds produced by the metric, if the metric implements
ThresholdProducingMetric.
|
static java.util.List<java.lang.String> |
getPluginMetricNames()
Get a list of plugin metric names
|
boolean |
metricIsMaximisable(java.lang.String statName)
Returns true if the named metric is maximisable
|
void |
setEvaluation(Evaluation eval)
Sets the Evaluation object to use
|
public EvaluationMetricHelper(Evaluation eval)
eval
- the Evaluation object to usepublic void setEvaluation(Evaluation eval)
eval
- the Evaluation object to usepublic static java.util.List<java.lang.String> getBuiltInMetricNames()
public static java.util.List<java.lang.String> getPluginMetricNames()
public static java.util.List<java.lang.String> getAllMetricNames()
public double getNamedMetric(java.lang.String statName, int... classValIndex) throws java.lang.Exception
statName
- the name of the metric/statistic to getclassValIndex
- the optional class value indexjava.lang.Exception
- if the metric/stat is unknown or a problem occurspublic double[] getNamedMetricThresholds(java.lang.String statName) throws java.lang.Exception
statName
- the name of the metric/statistic to getjava.lang.Exception
- if the metric/stat is unknown or a problem occurspublic boolean metricIsMaximisable(java.lang.String statName) throws java.lang.Exception
statName
- the name of the metric/statistic to checkjava.lang.Exception
- if a problem occurs