KSLCore/ksl.utilities.statistic/Histogram/Companion

Companion

object Companion(source)

Functions

Link copied to clipboard
@JvmStatic
fun addLowerLimit(lowerLimit: Double, breakPoints: DoubleArray): DoubleArray
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JvmStatic
fun addUpperLimit(upperLimit: Double, breakPoints: DoubleArray): DoubleArray
Link copied to clipboard
@JvmStatic
fun approximateStdDev(numObs: Double, range: Double): Double

Approximates the standard deviation of data via the range. See equation (9) in reference

Link copied to clipboard
@JvmStatic
fun create(upperLimit: Double, numBins: Int): HistogramIfc

Create a histogram with the lower limit set to zero

@JvmStatic
fun create(lowerLimit: Double, upperLimit: Double, numBins: Int): HistogramIfc

Create a histogram

@JvmStatic
fun create(lowerLimit: Double, numBins: Int, width: Double): HistogramIfc

@JvmStatic
@JvmOverloads
fun create(array: DoubleArray, breakPoints: DoubleArray = recommendBreakPoints(array), name: String? = null): Histogram

Creates a default histogram based on default break points for the supplied data

@JvmStatic
fun create(lowerLimit: Double, upperLimit: Double, numBins: Int, name: String?): HistogramIfc

Create a histogram with the given name based on the provided values

Link copied to clipboard
@JvmStatic
fun createBreakPoints(lowerLimit: Double, upperLimit: Double, numBins: Int): DoubleArray

Divides the range equally across the number of bins.

@JvmStatic
fun createBreakPoints(lowerLimit: Double, numBins: Int, width: Double): DoubleArray
Link copied to clipboard
@JvmStatic
fun makeBins(breakPoints: DoubleArray): List<HistogramBin>

Creates a list of ordered bins for use in a histogram

Link copied to clipboard
@JvmStatic
fun recommendBinWidth(numObs: Double, stdDev: Double): Double

Recommends a histogram bin width based on this paper

Link copied to clipboard
@JvmStatic
fun recommendBreakPoints(observations: DoubleArray): DoubleArray
@JvmStatic
fun recommendBreakPoints(statistic: StatisticIfc): DoubleArray

http://www.fmrib.ox.ac.uk/analysis/techrep/tr00mj2/tr00mj2/node24.html

Link copied to clipboard
@JvmStatic
fun recommendNumBins(numObs: Double, min: Double, max: Double, stdDev: Double): Int

Recommends a suitable number of bins for a histogram.