Skip to content

Features

Histogram - GetAverage

Computes the average of the histogram's frequencies.

IN

Name Type Description
InHistogram Histogram The input Histogram
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutDouble Double Average.
Error ErrorState Gets the execution error message

Histogram - GetLocalExtrema

Computes the histogram local extrema.

IN

Name Type Description
InHistogram Histogram The input Histogram
InConsiderPlateaus Bool Whether the result should include centers of plateau extrema.
InExtremumType Enum < ExtremumType > Type of extremum to find (minimum, maximum or both).
InCyclic Bool Whether to consider the histogram as cyclic.
InInterpolationMethod Enum < InterpolationMethod1D > Interpolation method.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutHistogramExtremum HistogramExtremumArray Local extrema.
Error ErrorState Gets the execution error message

Histogram - GetMaximum

Computes the higher histogram's frequency.

IN

Name Type Description
InHistogram Histogram The input Histogram
InInterpolationMethod Enum < InterpolationMethod1D > Interpolation method.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutDouble Double Maximum value.
Error ErrorState Gets the execution error message

Histogram - GetMinimum

Computes the lowest histogram's frequency.

IN

Name Type Description
InHistogram Histogram The input Histogram
InInterpolationMethod Enum < InterpolationMethod1D > Interpolation method.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutDouble Double Minimum value.
Error ErrorState Gets the execution error message

Histogram - GetSum

Computes the sum of the histogram's frequencies.

IN

Name Type Description
InHistogram Histogram The input Histogram
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutDouble Double Bins' sum.
Error ErrorState Gets the execution error message