Package clickTrainDetector.classification.bearingClassifier

Class BearingClassification

java.lang.Object

clickTrainDetector.classification.bearingClassifier.BearingClassification

All Implemented Interfaces:

CTClassification

public class BearingClassification
extends Object
implements CTClassification

Classification result from the bearing classifier.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
BearingClassification(int speciesID, double meanBearingDiff, double medianBearingDiff, double stdBearingDiff)	Constructor for the bearing classifier.
BearingClassification(String jsonstring)	Bearing classification from a JSON string.

Method Summary

Modifier and Type	Method	Description
CTClassifierType	getClassifierType()	The classifier type
ClassifierJSONLogging	getJSONLogging()	Get string logging for the classifier.
double	getMeanDelta()	Get the mean of bearing delta values in radians per second.
double	getMedianDelta()	Get the median of bearing delta values in radians per second.
int	getSpeciesID()	Get the species ID for the classifier.
double	getStdDelta()	Get the standard deviation in bearing delta values in radians per second.
String	getSummaryString()	Get summary string for classifiers.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BearingClassification

public BearingClassification(int speciesID,
 double meanBearingDiff,
 double medianBearingDiff,
 double stdBearingDiff)

Constructor for the bearing classifier.

Parameters:

speciesID - - the speciesID flag.

meanBearingDiff - - the mean bearing derivative of a click train in RADIANS/SECOND

medianBearingDiff - - the median bearing derivative of a click train in RADIANS/SECOND

stdBearingDiff - - the standard deviation of the bearing derivative of a click train in RADIANS/SECOND

BearingClassification

public BearingClassification(String jsonstring)

Bearing classification from a JSON string.

Parameters:

jsonstring - - JSON string containing the bearing data.

Method Details

getClassifierType

public CTClassifierType getClassifierType()

Description copied from interface: CTClassification

The classifier type

Specified by:

getClassifierType in interface CTClassification

Returns:

the classifier type

getSpeciesID

public int getSpeciesID()

Description copied from interface: CTClassification

Get the species ID for the classifier. 0 is unassigned and will results in the click train being deleted . >0 means the click train has been classified. invalid input: '<'0 means that the click train has been detected but not classified.

Specified by:

getSpeciesID in interface CTClassification

Returns:

the species ID for the classifier.

getSummaryString

public String getSummaryString()

Description copied from interface: CTClassification

Get summary string for classifiers.

Specified by:

getSummaryString in interface CTClassification

Returns:

a string summary of classifiers.

getJSONLogging

public ClassifierJSONLogging getJSONLogging()

Description copied from interface: CTClassification

Get string logging for the classifier.

Specified by:

getJSONLogging in interface CTClassification

Returns:

the JSON logging

getMedianDelta

public double getMedianDelta()

Get the median of bearing delta values in radians per second.

Returns:

the median bearing delta in rad/s.

getMeanDelta

public double getMeanDelta()

Get the mean of bearing delta values in radians per second.

Returns:

the mean bearing delta in rad/s

getStdDelta

public double getStdDelta()

Get the standard deviation in bearing delta values in radians per second.

Returns:

the standard deviation in bearing delta in rad/s