mode Property

Description

A read-write property used to specify how the histogram values and statistics are reported.

Property type

A mcHistogramMode enumeration.

Syntax

object.mode [= value]

The mode Property syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McHistogram.
value	A mcHistogramMode enumeration, as described in settings.

Settings

The settings for value are:

Constant		Value	Description
	mchmDefault	0	Histogram values and statistics are based on raw pixel spatial and intensity values, with bin intensities set to their left value. All frames in an enabled ActiveFrameRange are used and pixels considered are restricted to those within any Aoi.
	mchmApplySpatialCalibration	1	Histogram values and statistics take into account the current spatial calibration.
	mchmApplyIntensityCalibration	2	Histogram values and statistics take into account the current intensity calibration.
	mchmCenterBinValues	4	Bin intensities are set to their center value instead of left.
	mchmProcessActiveFrameOnly	8	If set, histogram values and statistics are based only on the source McImage.ActiveFrame. If clear (the default), histogram values and statistics are based on pixels within all frames in the McImage.ActiveFrameRange.
	mchmIgnoreAoi	16	If set, histogram values and statistics are based on the entire source McImage. If clear (the default), the histogram is based on only those pixels within any source McImage.Aoi

Remarks

The value of this property is a combination (OR) of mcHistogramMode values.