Skip to content
Last updated

API / geotoolkit / controls / util / histogram / HistogramUtils / HistogramUtils

Class: HistogramUtils

histogram.HistogramUtils.HistogramUtils

Defines an utility class for Histogram

Table of contents

Methods

Contents

Methods

calculateDistribution

▸ Static calculateDistribution(values, options?): DistributionOut

Calculate the distribution for a histogram, including frequencies and accumulated frequencies. This method processes input values and applies optional parameters to customize the binning process.

Parameters

Name Type Description
valuesnumber[] | INumericalDataSeriesarray of input values or data series for which the histogram distribution will be calculated.
Optional optionsDistributionOptionsOptional parameters for customizing the histogram distribution calculation, such as the number of bins, minimum/maximum values, and binning behavior.

Returns

DistributionOut

calculated frequencies


calculateMinMaxValues

▸ Static calculateMinMaxValues(values): Object

Calculates the minimum and maximum values, as well as the number of valid samples (excluding NaN values).

Parameters

Name Type Description
valuesnumber[] | INumericalDataSeriesAn array of numeric values or data series with numeric values.

Returns

Object

An object containing the minimum value, maximum value, and the count of valid samples.

NameType
maxValuenumber
minValuenumber
samplesCountnumber

calculateNumberOfBins

▸ Static calculateNumberOfBins(values, minValue?, maxValue?): number

Calculates the optimal number of bins for a given set of raw values.

Parameters

Name Type Description
valuesnumber[] | INumericalDataSeriesAn array of numeric values or data series.
Optional minValuenumberThe minimum value. If not provided, it will be recalculated from the raw values.
Optional maxValuenumberThe maximum value. If not provided, it will be recalculated from the raw values.

Returns

number

The calculated number of bins.