TrigonometricMoment (BioCommons 3.0.4 API)

java.lang.Object
- pl.poznan.put.circular.samples.TrigonometricMoment

Direct Known Subclasses:

ImmutableTrigonometricMoment
```
@Immutable
public abstract class TrigonometricMoment
extends Object
```
A quantitative measure of a trigonometric sample shape.

Constructor Summary

Constructors
Constructor Description

TrigonometricMoment()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static TrigonometricMoment`	`computeCentered(Collection<Angle> data, int p, Angle theta)`	Computes a centered moment i.e. relative to the mean value in the sample.
`static TrigonometricMoment`	`computeUncentered(Collection<Angle> data, int p)`	Computes an uncentered moment i.e. from the data points not relative to any specific point.
`abstract Angle`	`meanDirection()`
`abstract double`	`meanResultantLength()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TrigonometricMoment
```
public TrigonometricMoment()
```
- Method Detail
  - computeUncentered
```
public static TrigonometricMoment computeUncentered(Collection<Angle> data,
                                                    int p)
```
    Computes an uncentered moment i.e. from the data points not relative to any specific point.
    
    Parameters:
    
    data - A collection of angular values.
    
    p - A p-th moment to be calculated.
    
    Returns:
    
    The p-th uncentered trigonometric moment of the sample.
  - computeCentered
```
public static TrigonometricMoment computeCentered(Collection<Angle> data,
                                                  int p,
                                                  Angle theta)
```
    Computes a centered moment i.e. relative to the mean value in the sample.
    
    Parameters:
    
    data - A collection of angular values.
    
    p - A p-th moment to be calculated.
    
    theta - The mean value in the sample
    
    Returns:
    
    The p-th centered trigonometric moment of the sample.
  - meanDirection
```
@Parameter(order=1)
public abstract Angle meanDirection()
```
    Returns:
    
    The mean direction.
  - meanResultantLength
```
@Parameter(order=2)
public abstract double meanResultantLength()
```
    Returns:
    
    The length of the vector representing the mean direction.