Description

Specifies the intensity range “phase” to automatically find to set the IntensityRange property.

Property type

A mcFindPhase enumeration.  

Syntax

object.AutoFindPhase [= value]

The AutoFindPhase Property syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McThreshold.
valueA mcFindPhase enumeration, as described in settings.

Settings

The settings for value are:

ConstantValueDescription
 mcfpCurrent-1

for the PhaseToFind argument for the FindIntensity Range method. Finds whichever phase is already set in the AutoFindPhase property.

 mcfpDarkest0

Lowest (darkest) thresholds phase (intensity range). This is equivalent to phase 0 always.

 mcfpBrightest65535

Highest (brightest) thresholds phase (intensity range). This will always be Threshold.Histogram.MaxPhaseNumber-1, which in turn will depend on the Method argument to any Threshold.Histogram.SetThresholdParameters call.

 mcfpManual65536

For the AutoFindPhase property. IntensityMin and IntensityMax threshold levels are user defined.

 mcfpIgnoreAoi131072

If this bit is set, then auto phase detection and thresholding covers the entire source McImage. If clear (the default), auto phase detection and thresholding covers only those pixels within any source McImage.Aoi. This AutoFindPhase property bit also controls whether the region detected by Execute when it is given a SeedPoint is restricted to the Aoi --- if mcfpIgnoreAoi is set, then it is not restricted to the Aoi, otherwise it is.

Remarks

An intensity phase is some section of the source luminance range from McImage.RangeMin to McImage.RangeMax. When this property is set to some value less than mcfpManual, then before Execute does the thresholding, it will call FindIntensityRange to automatically set the IntensityRange property to this phase. If the value is mcfpManual, then no change at all is made to the IntensityRange property values; i.e., caller must assign the IntensityRange property themself prior to calling Execute. Otherwise this can be either mcfpDarkest for the darkest phase (this is always phase 0) or mcfpBrightest for the brightest phase (this is always McThreshold.Histogram.MaxThresholdPhases-1). Or it can be a numeric phase number starting at zero (lowest luminance phase) up through McThreshold.Histogram.MaxThresholdPhases-1 (highest luminance phase). Phase numbers greater than McThreshold.Histogram.MaxThresholdPhases-1 are silently set to be mcfpBrightest. By default there are only these two phases. See FindIntensityRange for more discussion.

By default the AutoFindPhase property is set to mcfpBrightest.

Notes

The mcfpIgnoreAoi bit may be OR'ed into the property value to cause the Aoi to be ignored during both phase intensity range detection and the threshold Execute operation. This AutoFindPhase property bit also controls whether the region detected by Execute when a SeedPoint is given is restricted to the Aoi if mcfpIgnoreAoi is set, then it is not restricted to the Aoi, otherwise it is.