Package sc.fiji.snt.analysis.growth

Record Class GrowthAnalysisResults.GrowthSummaryStatistics

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.growth.GrowthAnalysisResults.GrowthSummaryStatistics
Enclosing class:
GrowthAnalysisResults
public static record GrowthAnalysisResults.GrowthSummaryStatistics(double meanGrowthRate, double stdGrowthRate, double meanTotalGrowth, double stdTotalGrowth, double meanRSquared, int totalRetractions, int totalElongations, int neuriteCount) extends Record
Container for summary statistics across all analyzed neurites.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GrowthSummaryStatistics()
     
    GrowthSummaryStatistics(double meanGrowthRate, double stdGrowthRate, double meanTotalGrowth, double stdTotalGrowth, double meanRSquared, int totalRetractions, int totalElongations, int neuriteCount)
    Creates an instance of a GrowthSummaryStatistics record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    getElongationFrequency()
     
    double
    getRetractionFrequency()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    meanGrowthRate()
    Returns the value of the meanGrowthRate record component.
    double
    meanRSquared()
    Returns the value of the meanRSquared record component.
    double
    meanTotalGrowth()
    Returns the value of the meanTotalGrowth record component.
    int
    neuriteCount()
    Returns the value of the neuriteCount record component.
    double
    stdGrowthRate()
    Returns the value of the stdGrowthRate record component.
    double
    stdTotalGrowth()
    Returns the value of the stdTotalGrowth record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalElongations()
    Returns the value of the totalElongations record component.
    int
    totalRetractions()
    Returns the value of the totalRetractions record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GrowthSummaryStatistics

      public GrowthSummaryStatistics()

    • GrowthSummaryStatistics

      public GrowthSummaryStatistics(double meanGrowthRate, double stdGrowthRate, double meanTotalGrowth, double stdTotalGrowth, double meanRSquared, int totalRetractions, int totalElongations, int neuriteCount)
      Creates an instance of a GrowthSummaryStatistics record class.
      Parameters:
      meanGrowthRate - the value for the meanGrowthRate record component
      stdGrowthRate - the value for the stdGrowthRate record component
      meanTotalGrowth - the value for the meanTotalGrowth record component
      stdTotalGrowth - the value for the stdTotalGrowth record component
      meanRSquared - the value for the meanRSquared record component
      totalRetractions - the value for the totalRetractions record component
      totalElongations - the value for the totalElongations record component
      neuriteCount - the value for the neuriteCount record component

  • Method Details

    • getRetractionFrequency

      public double getRetractionFrequency()

    • getElongationFrequency

      public double getElongationFrequency()

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

    • meanGrowthRate

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

    • stdGrowthRate

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

    • meanTotalGrowth

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

    • stdTotalGrowth

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

    • meanRSquared

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

    • totalRetractions

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

    • totalElongations

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

    • neuriteCount

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