Package sc.fiji.snt.analysis

Record Class CircularModels.VonMisesFit

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.CircularModels.VonMisesFit
Record Components:
muDeg - mean direction/orientation in degrees (normalized by domain); NaN if undefined
kappa - concentration parameter (>= 0), estimated from rBar
rBar - mean resultant length in [0,1]; equals ADC (directional) or ODC (axial)
domain - domain of the angles used in the fit (directional vs axial)
Enclosing class:
CircularModels
public static record CircularModels.VonMisesFit(double muDeg, double kappa, double rBar, CircularModels.Domain domain) extends Record
Immutable summary of a von Mises fit on circular (directional) or axial (orientation) data.

Conventions used by SNT:

  • Domain.DIRECTIONAL operates on angles in [0,360[ degrees; opposite directions are distinct.
  • Domain.AXIAL operates on orientations in [0,180[ degrees; opposite directions are equivalent The reported muDeg is halved and normalized back to [0,180).
Values follow the usual circular–statistics definitions:
  • muDeg: mean direction/orientation in degrees. Normalized to [0,360[ for CircularModels.Domain.DIRECTIONAL and to [0,180) for CircularModels.Domain.AXIAL. May be NaN when the distribution is empty (total weight = 0).
  • kappa: von Mises concentration (unitless). Zero indicates a uniform distribution; larger values indicate stronger concentration. Estimated from the mean resultant length via CircularModels.kappaFromRBar(double).
  • rBar: mean resultant length in [0,1] (also written as R̄, “Rbar”). For CircularModels.Domain.DIRECTIONAL this equals the Angular Distribution Coherence (ADC); for CircularModels.Domain.AXIAL it equals the Orientation Distribution Coherence (ODC).
  • domain: identifies whether the fit was directional or axial; determines the normalization of muDeg and the interpretation of rBar.

Note that a single von Mises model is inherently unimodal;

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    VonMisesFit(double muDeg, double kappa, double rBar, CircularModels.Domain domain)
    Creates an instance of a VonMisesFit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    CircularModels.Domain
    domain()
    Returns the value of the domain record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    kappa()
    Returns the value of the kappa record component.
    double
    muDeg()
    Returns the value of the muDeg record component.
    double
    rBar()
    Returns the value of the rBar record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • VonMisesFit

      public VonMisesFit(double muDeg, double kappa, double rBar, CircularModels.Domain domain)
      Creates an instance of a VonMisesFit record class.
      Parameters:
      muDeg - the value for the muDeg record component
      kappa - the value for the kappa record component
      rBar - the value for the rBar record component
      domain - the value for the domain record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • muDeg

      public double muDeg()
      Returns the value of the muDeg record component.
      Returns:
      the value of the muDeg record component

    • kappa

      public double kappa()
      Returns the value of the kappa record component.
      Returns:
      the value of the kappa record component

    • rBar

      public double rBar()
      Returns the value of the rBar record component.
      Returns:
      the value of the rBar record component

    • domain

      public CircularModels.Domain domain()
      Returns the value of the domain record component.
      Returns:
      the value of the domain record component