net.talvi.puffinplot.data
Class FisherValues

java.lang.Object
  extended by net.talvi.puffinplot.data.FisherValues
All Implemented Interfaces:
FisherParams

public class FisherValues
extends java.lang.Object
implements FisherParams

This class calculates Fisher (1953) spherical statistics on sets of vectors.


Method Summary
static FisherValues calculate(java.util.Collection<Vec3> vectors)
          Returns a set of Fisherian statistics, calculated using the Fisher (1953) method, for a collection of vectors.
 double getA95()
          Returns the alpha-95 value denoting the 95% confidence interval.
 java.util.List<Vec3> getDirections()
          Returns the directions of the vectors on which these statistics were calculated.
static java.util.List<java.lang.String> getEmptyFields()
          Returns a list of empty strings equal in length to the number of parameters.
static java.util.List<java.lang.String> getHeaders()
          Returns the headers describing the parameters as a list of strings.
 double getK()
          Returns the k-value, an estimate of the precision parameter κ.
 Vec3 getMeanDirection()
          Returns the mean direction.
 int getNDirs()
          Returns the number of directions used to calculate these Fisherian parameters.
 java.lang.String toString()
          Returns a string representation of the parameters.
 java.util.List<java.lang.String> toStrings()
          Returns the statistical parameters as a list of strings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

calculate

public static FisherValues calculate(java.util.Collection<Vec3> vectors)
Returns a set of Fisherian statistics, calculated using the Fisher (1953) method, for a collection of vectors. The vectors do not need to be normalized; since Fisherian statistics are purely directional, their magnitudes will not influence the result.

Parameters:
vectors - the points on which to calculate statistics
Returns:
the Fisherian statistics for the supplied vectors

getA95

public double getA95()
Description copied from interface: FisherParams
Returns the alpha-95 value denoting the 95% confidence interval.

Specified by:
getA95 in interface FisherParams
Returns:
the alpha-95 value denoting the 95% confidence interval

getK

public double getK()
Description copied from interface: FisherParams
Returns the k-value, an estimate of the precision parameter κ.

Specified by:
getK in interface FisherParams
Returns:
the k-value, an estimate of the precision parameter κ

getNDirs

public int getNDirs()
Returns the number of directions used to calculate these Fisherian parameters.

Returns:
the number of directions used to calculate these Fisherian parameters

getMeanDirection

public Vec3 getMeanDirection()
Description copied from interface: FisherParams
Returns the mean direction.

Specified by:
getMeanDirection in interface FisherParams
Returns:
the mean direction

getDirections

public java.util.List<Vec3> getDirections()
Returns the directions of the vectors on which these statistics were calculated.

Returns:
the directions of the vectors on which these statistics were calculated

toStrings

public java.util.List<java.lang.String> toStrings()
Returns the statistical parameters as a list of strings. The order of the parameters is the same as the order of the headers provided by getHeaders().

Returns:
the statistical parameters as a list of strings

toString

public java.lang.String toString()
Returns a string representation of the parameters.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the parameters

getHeaders

public static java.util.List<java.lang.String> getHeaders()
Returns the headers describing the parameters as a list of strings.

Returns:
the headers describing the parameters

getEmptyFields

public static java.util.List<java.lang.String> getEmptyFields()
Returns a list of empty strings equal in length to the number of parameters.

Returns:
a list of empty strings equal in length to the number of parameters