CHistogram:Calc CHistogram:delete

CHistogram:Class Description


The CHistogram class is used to compute the frequency distribution, or "histogram", of an array of values. This class provides methods for choosing the binning strategy and for computing the histogram.

Usage

Construction

Object = CHistogram:new()

Destruction

Object:delete()

Class Properties

This class has no properties.

Class Methods

Construction

new

Creates a new instance of a CHistogram object.

delete

Deletes the instance of the CHistogram object.

Operations

Calc

Calculates the histogram using current binning parameters.

SetBinWidth

Configures the histogram to prioritize the bin width.

SetBinCount

Configures the histogram to prioritize the number of bins.

SetBinAuto

Sets the binning to automatically compute binning parameters. This is the default.

SetCorrelated

Allows faster computation when the data are correlated rather than randomly ordered.

Auto Binning Methods

These methods return the actual binning values that were used for auto binning mode.

GetBinCount

Returns the bin count that was used.

GetBinWidth

Returns the bin width that was used.

GetMin

Returns the minimum value used

GetMax

Returns the maximum value used.

Related Topics

Script Classes