Package sc.fiji.snt.analysis.curation

Record Class PlausibilityCheck.Measurements

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.curation.PlausibilityCheck.Measurements
Record Components:
values - the raw metric values (one per fork, node-pair, run, or path depending on the check). Never null.
notAssessable - the number of candidate units (forks, paths, etc.) that could not be evaluated (too few nodes, missing radii, missing image, etc.).
metric - short human-readable name of the metric used as the histogram's x-axis label.
unit - unit string ("µm", "ratio", or "" when dimensionless).
subject - singular noun describing what each value counts ("fork", "path", "cross-over", "node pair", "monotonic run", etc.).
domainMin - optional lower bound of the metric's natural domain. Double.NaN when unknown.
domainMax - optional upper bound of the metric's natural domain. Double.NaN when unknown.
emptyHint - optional check-specific message shown to the user when the result is empty or unassessable
Enclosing class:
PlausibilityCheck
public static record PlausibilityCheck.Measurements(double[] values, int notAssessable, String metric, String unit, String subject, double domainMin, double domainMax, String emptyHint) extends Record
Full distribution of a check's raw measurements across a reconstruction, collected without applying the warning threshold. Powers the per-check histogram popups in the Curation Assistant: showing the user where their data sits relative to the configured threshold is more informative than showing only the flagged subset.

  • Field Details

  • Constructor Details

    • Measurements

      public Measurements(double[] values, int notAssessable, String metric, String unit, String subject, double domainMin, double domainMax, String emptyHint)
      Compact constructor: guarantees non-null arrays and strings.

  • Method Details

    • withHint

      public PlausibilityCheck.Measurements withHint(String hint)
      Returns a copy of this record with emptyHint replaced. Avoids forcing every measure() call site to pass a hint through the constructor when only special cases need one.

    • isEmpty

      public boolean isEmpty()
      Returns:
      true if no values were collected.

    • assessed

      public int assessed()
      Returns:
      the count of evaluated units (size of values).

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

    • values

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

    • notAssessable

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

    • metric

      public String metric()
      Returns the value of the metric record component.
      Returns:
      the value of the metric record component

    • unit

      public String unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component

    • subject

      public String subject()
      Returns the value of the subject record component.
      Returns:
      the value of the subject record component

    • domainMin

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

    • domainMax

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

    • emptyHint

      public String emptyHint()
      Returns the value of the emptyHint record component.
      Returns:
      the value of the emptyHint record component