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

Record Class PolarProfileStats.PolarPeak

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.sholl.math.PolarProfileStats.PolarPeak
Record Components:
angleDeg - bin-center angle (Direction: [0,360[, Orientation: [0,180[)
value - the peak height in distribution units (counts or length)
bin - index of the peak bin in the distribution
Enclosing class:
PolarProfileStats
public static record PolarProfileStats.PolarPeak(double angleDeg, double value, int bin) extends Record
Simple container for angular peaks.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PolarPeak(double angleDeg, double value, int bin)
    Creates an instance of a PolarPeak record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    angleDeg()
    Returns the value of the angleDeg record component.
    int
    bin()
    Returns the value of the bin 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.
    String
    toString()
    Returns a string representation of this record class.
    double
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PolarPeak

      public PolarPeak(double angleDeg, double value, int bin)
      Creates an instance of a PolarPeak record class.
      Parameters:
      angleDeg - the value for the angleDeg record component
      value - the value for the value record component
      bin - the value for the bin record component

  • Method Details

    • toString

      public 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. All components in this record class 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.

    • angleDeg

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

    • value

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

    • bin

      public int bin()
      Returns the value of the bin record component.
      Returns:
      the value of the bin record component