public class FisherValues extends java.lang.Object implements FisherParams
Modifier and Type | Method and Description |
---|---|
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 a list of unit vectors representing
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 |
getN()
Returns N, the number of directions analysed.
|
int |
getNDirs()
Returns the number of directions used to calculate these Fisherian parameters.
|
double |
getR()
Returns R, the total unit vector path length.
|
boolean |
isA95Valid()
Reports whether the alpha-95 value represents a real number.
|
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.
|
static java.util.List<java.lang.String> |
toStrings(FisherValues fisherValues)
Returns the statistical parameters as a list of strings.
|
public static FisherValues calculate(java.util.Collection<Vec3> vectors)
vectors
- the points on which to calculate statisticspublic double getA95()
FisherParams
getA95
in interface FisherParams
public boolean isA95Valid()
FisherParams
isA95Valid
in interface FisherParams
public double getK()
FisherParams
getK
in interface FisherParams
public int getN()
FisherParams
getN
in interface FisherParams
public double getR()
FisherParams
getR
in interface FisherParams
public int getNDirs()
public Vec3 getMeanDirection()
FisherParams
getMeanDirection
in interface FisherParams
public java.util.List<Vec3> getDirections()
public java.util.List<java.lang.String> toStrings()
getHeaders()
.toStrings(net.talvi.puffinplot.data.FisherValues)
public static java.util.List<java.lang.String> toStrings(FisherValues fisherValues)
getHeaders()
.
It returns the same result as the corresponding instance method
for any non-null input, but (unlike the instance method)
also works for a null
FisherValues
.fisherValues
- the Fisher parameters to return as stringsfisherValues
was null
toStrings()
public java.lang.String toString()
toString
in class java.lang.Object
public static java.util.List<java.lang.String> getHeaders()
public static java.util.List<java.lang.String> getEmptyFields()