Package sc.fiji.snt.analysis

Record Class MultiSpectralRefiner.Parameters

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.MultiSpectralRefiner.Parameters
Enclosing class:
MultiSpectralRefiner
public static record MultiSpectralRefiner.Parameters(double intensityWeight, double colorWeight, double radiusWeight, double cosSimilarityThreshold, double backgroundThreshold, double minIntensityThreshold, double maxIntensityThreshold, double minPercentC, double maxPercentC, int maxRadius, int maxIterations, double convergenceThreshold, int referenceWindowRadius, boolean autoTune) extends Record
Immutable parameter set for multispectral refinement. Provides a convenient way to configure multiple refiners consistently.

Intensity thresholds (minIntensityThreshold, maxIntensityThreshold) can be set to Double.NaN to use auto-calibrated values based on the image's bit depth (the default behavior).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Parameters(double intensityWeight, double colorWeight, double radiusWeight, double cosSimilarityThreshold, double backgroundThreshold, double minIntensityThreshold, double maxIntensityThreshold, double minPercentC, double maxPercentC, int maxRadius, int maxIterations, double convergenceThreshold, int referenceWindowRadius, boolean autoTune)
    Creates an instance of a Parameters record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    autoTune()
    Returns the value of the autoTune record component.
    double
    backgroundThreshold()
    Returns the value of the backgroundThreshold record component.
    double
    colorWeight()
    Returns the value of the colorWeight record component.
    double
    convergenceThreshold()
    Returns the value of the convergenceThreshold record component.
    double
    cosSimilarityThreshold()
    Returns the value of the cosSimilarityThreshold record component.
    static MultiSpectralRefiner.Parameters
    defaults()
    Default parameters: weights and thresholds from the nCorrect publication, with intensity thresholds set to NaN (auto-calibrated from bit depth).
    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
    intensityWeight()
    Returns the value of the intensityWeight record component.
    double
    maxIntensityThreshold()
    Returns the value of the maxIntensityThreshold record component.
    int
    maxIterations()
    Returns the value of the maxIterations record component.
    double
    maxPercentC()
    Returns the value of the maxPercentC record component.
    int
    maxRadius()
    Returns the value of the maxRadius record component.
    double
    minIntensityThreshold()
    Returns the value of the minIntensityThreshold record component.
    double
    minPercentC()
    Returns the value of the minPercentC record component.
    double
    radiusWeight()
    Returns the value of the radiusWeight record component.
    int
    referenceWindowRadius()
    Returns the value of the referenceWindowRadius 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

    • Parameters

      public Parameters(double intensityWeight, double colorWeight, double radiusWeight, double cosSimilarityThreshold, double backgroundThreshold, double minIntensityThreshold, double maxIntensityThreshold, double minPercentC, double maxPercentC, int maxRadius, int maxIterations, double convergenceThreshold, int referenceWindowRadius, boolean autoTune)
      Creates an instance of a Parameters record class.
      Parameters:
      intensityWeight - the value for the intensityWeight record component
      colorWeight - the value for the colorWeight record component
      radiusWeight - the value for the radiusWeight record component
      cosSimilarityThreshold - the value for the cosSimilarityThreshold record component
      backgroundThreshold - the value for the backgroundThreshold record component
      minIntensityThreshold - the value for the minIntensityThreshold record component
      maxIntensityThreshold - the value for the maxIntensityThreshold record component
      minPercentC - the value for the minPercentC record component
      maxPercentC - the value for the maxPercentC record component
      maxRadius - the value for the maxRadius record component
      maxIterations - the value for the maxIterations record component
      convergenceThreshold - the value for the convergenceThreshold record component
      referenceWindowRadius - the value for the referenceWindowRadius record component
      autoTune - the value for the autoTune record component

  • Method Details

    • defaults

      public static MultiSpectralRefiner.Parameters defaults()
      Default parameters: weights and thresholds from the nCorrect publication, with intensity thresholds set to NaN (auto-calibrated from bit depth). Reference window is -1 (global, single reference per path). Auto-tune is off by default.

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

    • intensityWeight

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

    • colorWeight

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

    • radiusWeight

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

    • cosSimilarityThreshold

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

    • backgroundThreshold

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

    • minIntensityThreshold

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

    • maxIntensityThreshold

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

    • minPercentC

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

    • maxPercentC

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

    • maxRadius

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

    • maxIterations

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

    • convergenceThreshold

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

    • referenceWindowRadius

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

    • autoTune

      public boolean autoTune()
      Returns the value of the autoTune record component.
      Returns:
      the value of the autoTune record component