Package sc.fiji.snt.analysis.sholl.math

Record Class PolarProfileStats.Report

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.sholl.math.PolarProfileStats.Report
Record Components:
directionPeaks - unmodifiable list of directional peaks ([0,360[ degrees), sorted by descending height
orientationPeaks - unmodifiable list of orientation peaks ([0,180[ degrees), sorted by descending height
adc - Angular Distribution Coherence (ADC) in [0,1]. Higher values indicate greater concentration of weight around a single direction; 0 indicates a uniform distribution.
odc - Orientation Distribution Coherence in [0,1]. This is a variant of ADC that is insensitive to arrow direction. ranging from [0, 1]. High values indicate mass concentrated along a line; low values indicate near-uniform angular. distribution. NB: ODC can capture morphologies that are symmetric across 180° (two opposite lobes) for which ADC can be near 0.
pd - Preferred direction angle in [0,360[ degrees
po - Preferred orientation angle in [0,180[ degrees
vmDirectional - Optional von Mises fit for the directional distribution (non-null only if unimodal)
vmAxial - Optional von Mises fit for the axial/orientation distribution (non-null only if unimodal)
Enclosing class:
PolarProfileStats
public static record PolarProfileStats.Report(List<PolarProfileStats.PolarPeak> directionPeaks, List<PolarProfileStats.PolarPeak> orientationPeaks, double adc, double odc, double pd, double po, CircularModels.VonMisesFit vmDirectional, CircularModels.VonMisesFit vmAxial) extends Record
Immutable summary of the global polar distribution.

  • Constructor Details

  • Method Details

    • toString

      public String toString()
      Creates an adaptive summary tailored to common regimes:
      • No preferred directions when both ADC and ODC are very low or no peaks are found.
      • Single preferred direction when ADC is strong and exactly one robust peak is detected.
      • Preferred orientation (axis) when ODC is strong but ADC is weak.
      • Multiple preferred directions listing up to three top angles otherwise.
      Specified by:
      toString in class Record

    • 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.

    • directionPeaks

      public List<PolarProfileStats.PolarPeak> directionPeaks()
      Returns the value of the directionPeaks record component.
      Returns:
      the value of the directionPeaks record component

    • orientationPeaks

      public List<PolarProfileStats.PolarPeak> orientationPeaks()
      Returns the value of the orientationPeaks record component.
      Returns:
      the value of the orientationPeaks record component

    • adc

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

    • odc

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

    • pd

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

    • po

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

    • vmDirectional

      public CircularModels.VonMisesFit vmDirectional()
      Returns the value of the vmDirectional record component.
      Returns:
      the value of the vmDirectional record component

    • vmAxial

      public CircularModels.VonMisesFit vmAxial()
      Returns the value of the vmAxial record component.
      Returns:
      the value of the vmAxial record component