HistogramParameters

MLModule

genre	Histogram
status	stable
author	Jan Rexilius
package	MeVisLab/Standard
dll	MLVolumetry
definition	MLVolumetry.def
keywords	histogram, parameter, normalize, minimum, maximum, quantile, mean, peak, sum, fwhm

Purpose

The module HistogramParameters computes parameters from a given histogram.

Windows

Default Panel

Input Fields

inHistogram

name: inHistogram, type: MLBase, deprecated name: histogram

Output Fields

outHistogramCurve

name: outHistogramCurve, type: MLBase, deprecated name: outputHistogramCurve

Parameter Fields

Field Index

#Non Empty Bins in Interval: Float	Minimum: Float	Q25%: Float
End Position: Float	Non-Zero Height: Float	Q50% (median): Float
Entropy: Float	Non-Zero Maximum: Float	Q75%: Float
FWHM: Float	Non-Zero Mean Height: Float	Q_p1%: Float
FWHM-left: Float	Non-Zero Minimum: Float	Q_p2%: Float
FWHM-right: Float	Non-Zero Position: Float	Standard Deviation of Histogram: Float
Height: Float	normalize100: Bool	Start Position: Float
Interval Sum: Float	p1(0%-100%): Float	Sum: Float
Maximum: Float	p2(0%-100%): Float	Use normalized histogram: Bool
Mean Height: Float	Position (maxPeakPos): Float	useStepFunction: Bool
Mean Position: Float	Position (fwhmPosition): Float

Visible Fields

Use normalized histogram

name: normalize, type: Bool, default: FALSE

If checked, the histogram is normalized before computing parameters.

p1(0%-100%)

name: quantileArg, type: Float, default: 5, deprecated name: quantileValue

Sets the quantile for Q\_p1%.

p2(0%-100%)

name: quantile2Arg, type: Float, default: 95, deprecated name: quantile2Value

Sets the quantile for Q\_p2%.

Q_p1%

name: quantileX, type: Float, default: 0

Shows the quantile for p1(0%-100%).

Q_p2%

name: quantile2X, type: Float, default: 0

Shows the quantile for p2(0%-100%).

Q25%

name: quantile25, type: Float, default: 1

Shows the 25% quantile.

Q50% (median)

name: quantile50, type: Float, default: 1

Shows the 50% quantile (the median).

Q75%

name: quantile75, type: Float, default: 1

Shows the 75% quantile.

Position (maxPeakPos)

name: maxPeakPos, type: Float, default: 1

Shows the position of the highest peak of the histogram.

Height

name: maxPeakHeight, type: Float, default: 1

Shows the height of the highest peak of the histogram.

FWHM

name: fwhm, type: Float, default: 0, deprecated name: FWHM

Shows the FWHM value using left side and right side for computation.

Position (fwhmPosition)

name: fwhmPosition, type: Float, default: 1, deprecated name: FWHMposition

Sets the position for the FHWM computation.

Sum

name: sum, type: Float, default: 1

Shows the sum of histogram entries.

Mean Height

name: meanHeight, type: Float, default: 1

Shows the mean height of the histogram.

Non-Zero Mean Height

name: nonZeroMeanHeight, type: Float, default: 1

Shows the mean height of the non-zero histogram entries.

Mean Position

name: meanPos, type: Float, default: 1

Shows the mean position of the histogram.

Standard Deviation of Histogram

name: standardDev, type: Float, default: 1

Shows the standard deviation of the histogram.

Minimum

name: minPos, type: Float, default: 1

Shows the minimal histogram position.

Maximum

name: maxPos, type: Float, default: 1

Shows the maximal histogram position.

Non-Zero Minimum

name: nonZeroMinPos, type: Float, default: 1

Shows the minimal histogram position using only non-zero histogram entries.

Non-Zero Maximum

name: nonZeroMaxPos, type: Float, default: 1

Shows the maximal histogram position using only non-zero histogram entries.

Start Position

name: startPos, type: Float, default: 0

Sets the start position for the sum within the interval.

End Position

name: endPos, type: Float, default: 0

Sets the end position for the sum within the interval.

Interval Sum

name: intervalSum, type: Float, default: 0

Shows the sum of entries within the set interval.

FWHM-left

name: fwhmLeft, type: Float, default: 1

Shows the FHWM value using only the left side for computation.

FWHM-right

name: fwhmRight, type: Float, default: 1

Shows the FHWM value using only the right side for computation.

Entropy

name: entropy, type: Float, default: 0

Shows the entropy value of the histogram.

Non-Zero Position

name: maxNonZeroPeakPos, type: Float, default: 1

Shows the position of the non-zero peak of the histogram.

Non-Zero Height

name: maxNonZeroPeakHeight, type: Float, default: 0

Shows the height of the peak of the non-zero histogram.

#Non Empty Bins in Interval

name: numNonEmptyBins, type: Float, default: 0

Shows the number of non-empty bins within the interval.

Hidden Fields

normalize100

name: normalize100, type: Bool, default: FALSE

useStepFunction

name: useStepFunction, type: Bool, default: FALSE