Package org.aavso.tools.vstar.util.stats.epoch

Class MaxMagEpochStrategy

java.lang.Object

org.aavso.tools.vstar.util.stats.epoch.MaxMagEpochStrategy

All Implemented Interfaces:

IEpochStrategy

public class MaxMagEpochStrategy
extends Object
implements IEpochStrategy

This epoch determination strategy finds the numerically maximum magnitude value in the dataset. This magnitude's JD becomes the epoch. TODO: should this instead mean the numerically smallest, i.e. brightest magnitude? Which is less confusing to the end-user?

Constructor Summary

Constructors

Constructor	Description
MaxMagEpochStrategy()

Method Summary

Modifier and Type	Method	Description
double	determineEpoch(List<ValidObservation> obs)	Determine the epoch for a given sequence of observations.
String	getDescription()

Methods inherited from class java.lang.Object

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

Constructor Details

MaxMagEpochStrategy

public MaxMagEpochStrategy()

Method Details

determineEpoch

public double determineEpoch(List<ValidObservation> obs)

Description copied from interface: IEpochStrategy

Determine the epoch for a given sequence of observations.

Specified by:

determineEpoch in interface IEpochStrategy

Parameters:

obs - A sequence of valid observations.

Returns:

The epoch as a double JD value.

See Also:

• IEpochStrategy.determineEpoch(java.util.List)

getDescription

public String getDescription()

Specified by:

getDescription in interface IEpochStrategy

Returns:

A human readable description of the epoch determination strategy.

See Also:

• IEpochStrategy.getDescription()