Table of Contents

Calc Histogram

Description

Calculates a histogram from a map.

Inputs

Name Type Description
Map Map Type Any map.

Optional Inputs

Name Type Description Default Value
Interval Width Real Value Type Width of each histogram interval (bin). 1
Cumulative Boolean Value Type If true, the calculated histogram is cumulative. No
Relative Boolean Value Type If true, the values in the histogram are normalized by the total number of occurrences. No

Outputs

Name Type Description
Histogram Lookup Table Type The calculated histogram.

Group

Statistics

Notes

Only the map's first layer is used to build the histogram.

Each key in the output table is the lower bound of an interval, obtained by rounding the corresponding cell value down to the nearest multiple of Interval Width; the associated value is the count of cells falling in that interval (or, if Relative is true, that count divided by the total number of non-null cells). Because of this rounding, the lowest and highest keys in the resulting table can fall outside the range of values actually present in Map.

Setting both Cumulative and Relative produces a histogram of cumulative relative frequencies.

Raises an error if Interval Width is not greater than 0.

Internal Name

CalcHistogram