Package adams.data.trail

Class TrailStatistic

java.lang.Object

adams.core.logging.LoggingObject

adams.data.statistics.AbstractDataStatistic<Trail>

adams.data.trail.TrailStatistic

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, adams.data.spreadsheet.SpreadSheetSupporter, adams.data.statistics.InformativeStatistic, Serializable

public class TrailStatistic
extends adams.data.statistics.AbstractDataStatistic<Trail>

Statistical information specific to a trail.

Version:

$Revision: 2162 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FIRST_TIMESTAMP
static String	LAST_TIMESTAMP
static String	MAX_DELTA_TIMESTAMP
static String	MAX_DELTA_X
static String	MAX_DELTA_Y
static String	MAX_X
static String	MAX_Y
static String	MEAN_DELTA_TIMESTAMP
static String	MEAN_DELTA_X
static String	MEAN_DELTA_Y
static String	MEDIAN_DELTA_TIMESTAMP
static String	MEDIAN_DELTA_X
static String	MEDIAN_DELTA_Y
static String	MIN_DELTA_TIMESTAMP
static String	MIN_DELTA_X
static String	MIN_DELTA_Y
static String	MIN_X
static String	MIN_Y
static String	NUMBER_OF_POINTS
static String	STDEV_DELTA_TIMESTAMP
static String	STDEV_DELTA_X
static String	STDEV_DELTA_Y

Fields inherited from class adams.data.statistics.AbstractDataStatistic

m_Calculated, m_Data, m_Names, m_Statistics

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TrailStatistic()	Initializes the statistic.
TrailStatistic(Trail data)	Initializes the statistic.

Method Summary

Modifier and Type	Method	Description
protected void	calculate()	calculates the statistics.
void	cleanUp()	Cleans up data structures, frees up memory.
Trail	getData()	Returns the currently stored trail.
String	getStatisticDescription()	Returns a description for this statistic, i.e., trail ID.
String	globalInfo()	Returns a string describing the object.
void	setData(Trail value)	Sets the data to use as basis for the calculations.

Methods inherited from class adams.data.statistics.AbstractDataStatistic

add, clear, getStatistic, numberToDouble, statisticNames, toSpreadSheet, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

MIN_X

public static final String MIN_X

See Also:

Constant Field Values

MAX_X

public static final String MAX_X

See Also:

Constant Field Values

MIN_Y

public static final String MIN_Y

See Also:

Constant Field Values

MAX_Y

public static final String MAX_Y

See Also:

Constant Field Values

MEDIAN_DELTA_Y

public static final String MEDIAN_DELTA_Y

See Also:

Constant Field Values

STDEV_DELTA_Y

public static final String STDEV_DELTA_Y

See Also:

Constant Field Values

MEAN_DELTA_Y

public static final String MEAN_DELTA_Y

See Also:

Constant Field Values

MAX_DELTA_Y

public static final String MAX_DELTA_Y

See Also:

Constant Field Values

MIN_DELTA_Y

public static final String MIN_DELTA_Y

See Also:

Constant Field Values

MEDIAN_DELTA_X

public static final String MEDIAN_DELTA_X

See Also:

Constant Field Values

STDEV_DELTA_X

public static final String STDEV_DELTA_X

See Also:

Constant Field Values

MEAN_DELTA_X

public static final String MEAN_DELTA_X

See Also:

Constant Field Values

MAX_DELTA_X

public static final String MAX_DELTA_X

See Also:

Constant Field Values

MIN_DELTA_X

public static final String MIN_DELTA_X

See Also:

Constant Field Values

MEDIAN_DELTA_TIMESTAMP

public static final String MEDIAN_DELTA_TIMESTAMP

See Also:

Constant Field Values

STDEV_DELTA_TIMESTAMP

public static final String STDEV_DELTA_TIMESTAMP

See Also:

Constant Field Values

MEAN_DELTA_TIMESTAMP

public static final String MEAN_DELTA_TIMESTAMP

See Also:

Constant Field Values

MAX_DELTA_TIMESTAMP

public static final String MAX_DELTA_TIMESTAMP

See Also:

Constant Field Values

MIN_DELTA_TIMESTAMP

public static final String MIN_DELTA_TIMESTAMP

See Also:

Constant Field Values

LAST_TIMESTAMP

public static final String LAST_TIMESTAMP

See Also:

Constant Field Values

FIRST_TIMESTAMP

public static final String FIRST_TIMESTAMP

See Also:

Constant Field Values

NUMBER_OF_POINTS

public static final String NUMBER_OF_POINTS

See Also:

Constant Field Values

Constructor Detail

TrailStatistic

public TrailStatistic()

Initializes the statistic.

TrailStatistic

public TrailStatistic(Trail data)

Initializes the statistic.

Parameters:

data - the trail to generate the statistics for

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class adams.data.statistics.AbstractDataStatistic<Trail>

Returns:

a description suitable for displaying in the gui

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface adams.core.CleanUpHandler

Overrides:

cleanUp in class adams.data.statistics.AbstractDataStatistic<Trail>

setData

public void setData(Trail value)

Sets the data to use as basis for the calculations.

Overrides:

setData in class adams.data.statistics.AbstractDataStatistic<Trail>

Parameters:

value - the trail to use, can be null

getData

public Trail getData()

Returns the currently stored trail.

Overrides:

getData in class adams.data.statistics.AbstractDataStatistic<Trail>

Returns:

the trail, can be null

getStatisticDescription

public String getStatisticDescription()

Returns a description for this statistic, i.e., trail ID.

Returns:

the description

calculate

protected void calculate()

calculates the statistics.

Overrides:

calculate in class adams.data.statistics.AbstractDataStatistic<Trail>