mcHistogramMode Enumeration |
|
Values for the McHistogram.Mode and McHistogram.ModeMasked properties.Bits may be Or'ed together.
Namespace: MediaCy.IQL.Operations
Assembly: MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcHistogramMode
Members| Member name | Value | Description | |
|---|---|---|---|
| mchmNoBits | 0 | No Mode bits. | |
| mchmDefault | 0 | Histogram values andstatistics 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 | If set, histogramvalues and statistics take into account the current spatial calibration. | |
| mchmApplyIntensityCalibration | 2 | If set, histogramvalues and statistics take into account the current intensity calibration. | |
| mchmCenterBinValues | 4 | If set, theMcHistogram.BinXValues property intensity values are set to their center values instead of left-end-of-bin values. | |
| 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, unless the McImage.UseActiveFrameRange property is False, in which case only the Active Frame is scanned. Note that if the McHistogram.SamplingCoverage property is less than 100, and especially if the mchmFavorSkippedFramesWhenSampling bit is set, then some frames within the ActiveFrameRange may be skipped entirely. | |
| mchmIgnoreAoi | 16 | If set, histogramvalues 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 (if McImage.ImageSet is not-Nothing, then McImage.ImageSet.Aoi is used unless the mchmIgnoreImageSetAoi Mode bit is set, in which case McImage.Aoi is always used). | |
| mchmHonorLuminanceLimits | 32 | If set, thehistogram is computed over the luminance range given by the LuminanceLimits property. If not set, then the histogram is computed over the luminance range given by the source McImage.RangeMin and RangeMax. Note that if this McHistogram.Mode bit is set, then the length of the computed histogram may be less than the McHistogram.BinCount property value, but the McHistogram.LimitedBinCount property will always give the correct length for the computed histogram. | |
| mchmAutoSetLuminanceLimits | 64 | If set, theMcHistogram.LuminanceLimits property is automatically set to the actual lumiance range found in the ; this range will cover all luminance values found in any channel of the source image's data. If not set, then the McHistogram.LuminanceLimits is: A) the default of the source McImage.RangeMin to RangeMax, B) whatever has been assigned to it or C) the values last set by a McHistogram.ComputeLuminanceLimits call. Setting this bit is legal only if the McHistogram instance is not global (i.e., it has an ancestor McImage). Assigning to the LuminanceLimits property will automatically clear the mchmAutoSetLuminanceLimits Mode bit. | |
| mchmFavorSkippedFramesWhenSampling | 128 | If set and theMcHistogram.SamplingCoverage property is less than 100, then sampling will favor skipping whole frames from the McImage.ActiveFrameRange over skipping pixels within a frame. | |
| mchmExpose64bitRawValues | 256 | If set, theMcHistogram.RawValues property is exposed as scalar or an array of 64-bit signed integers. If not set, the property is exposed as 32-bit signed integers. If this bit is not set and the total count of source pixels needed to compute the histogram exceeds 2147483647 (the maximum positive value that will fit into a 32-bit signed integer), then an overflow error is returned on any attempt to access the RawValues property. | |
| mchmNoMessageDischarge | 512 | If set, nomessage loop discharge, progress meter update or user escape checks occur during histogram computation. If not set, then all of these actions may be performed. This bit should be set only when it is known that the operation can be performed in a timely manner. | |
| mchmFreezeResult | 1024 | If set, then thehistogram will not be automatically updated for changed parameters or ancestor image data changes. If not set, then whenever histogram values or statistics are accessed the histogram is re-computed if parameters or ancestor image data has changed since the last access. There are two primary uses for this bit: 1) to freeze the histogram data to capture a state of the ancestor image, and 2) to work in conjunction with the mchmAccumulateHistogram and mchmComputeOnce Mode bits to build up a histogram by calling Compute multiple times. The mchmFreezeResult bit is automatically set when the mchmAccumulateHistogram bit is set and it may not be cleared while the mchmAccumulateHistogram bit is set. When the mchmAccumulateHistogram bit is cleared, the mchmFreezeResult is left set, so as to preserve the final accumulated histogram result. | |
| mchmComputeOnce | 2048 | Setting this Modebit forces the histogram into a dirty state (needing a re-compute; see mchmHistogramIsDirty) and then temporarily disables the effect of the mchmFreezeResult bit, with which mchmComputeOnce is almost always paired. When McHistogram.Compute is next called, either directly or indirectly due to a value or statistics property access, then the histogram is computed (which will clear the mchmHistogramIsDirty bit) and then the mchmComputeOnce bit automatically is cleared. Thus the comibination of the mchmFreezeResult and mchmComputeOnce bits gives the caller complete control over when the histogram is computed. See mchmAccumulateHistogram for more discussion. | |
| mchmAccumulateHistogram | 4096 | When initiallyset, the histogram is cleared of all counts unless the mchmFreezeResult bit is already set. At this time, the mchmFreezeResult and mchmComputeOnce bits will also be automatically set. After mchmAccumulateHistogram is set, then every new computation of the histogram accumulates more counts into the bins. The purpose of setting the mchmComputeOnce bit along with the mchmAccumulateHistogram bit is to control exactly when a new set of histogram bin counts is added to the already existing bin counts. The mchmFreezeResult bit is automatically set when the mchmAccumulateHistogram bit is set and it may not be cleared while the mchmAccumulateHistogram bit is set. When the mchmAccumulateHistogram bit is cleared, the mchmFreezeResult is left set, so as to preserve the final accumulated histogram result. While the mchmAccumulateHistogram bit is set, any attempt to change the McHistogram properties that affect the size or limits of the histogram will result in an error. Thus if this bit is set, illegal assignments are those to BinCount, LuminanceLimits (if the mchmHonorLuminanceLimits bit is set) or setting both mchmHonorLuminanceLimits amd mchmAutoSetLuminanceLimits. An attempt to clear the mchmFreezeResult bit will also result in an error. | |
| mchmIgnoreImageSetAoi | 8192 | If set, and if themchmIgnoreAoi bit is clear, then values and statistics are always based on the source McImage.Aoi. If clear (the default), and if source McImage.ImageSet is not-Nothing, then McImage.ImageSet.Aoi is used to determine which pixels to include in the histogram. | |
| mchmHistogramIsDirty | 268435456 | This bitcannot be set by the user and it is only accessable as part of the McHistogram.ModeMasked, never the McHistogram.Mode property. The mchmHistogramIsDirty ModeMasked bit will be set whenever histogram values need to be re-computed, either because McHistogram parameters have been changed or because ancestor image data has changed. | |
| mchmAllSettableBits | 16383 | All assignableMcHistogram.Mode bits. These are the only bits that will appear in the McHistogram.Mode property; some bits outside of this set may be accessed via the McHistogram.ModeMasked property. | |
| mchmAllBits | -1 | All Mode bits. |
See Also