mcCompositeHostStatusFlags Enumeration |
|
Legal bit values for the McCompositeHost.Status property.
Namespace: MediaCy.IQL.Operations
Assembly: MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcCompositeHostStatusFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mcchsfNoFlags | 0 | No flags. | |
| mcchsfDestCreationOptions | 3 | Mask for the destination imagecreation options | |
| mcchsfCreateFullCoverage | 0 | The destination image is madelarge enough to encompass all offset sources. The DestOffsetXY is automatically adjusted to fit the sources into the created destination image. This is the default behavior. | |
| mcchsfCreateIntersection | 1 | The destination image iscreated so that the combine is done only where the all offset source rectangles overlap. The DestOffsetXY is automatically adjusted to fit the intersection of the offset source rectangles into the created destination image. If the offset intersection of the sources is empty, then the behavior is identical to having no sources. It is illegal to call ExecuteComposite in this situation. | |
| mcchsfCreateSmallest | 2 | The destination image ismade the same size as the smallest source. The DestOffsetXY is and SourceOffsetsXY are applied, so that some of the combine may be clipped. | |
| mcchsfCreateLargest | 3 | The destination image, itis made the same size as the largest source. The DestOffsetXY is and SourceOffsetsXY are applied, so that some of the combine may be clipped. | |
| mcchsfUpdateEnabled | 16 | When set, notifieswill be fired when any property assignment causes a change in the destination color composite result. If not set, then property assignments merely set the mcchsfChangeNotifyPending or mcchsfInfoNotifyPending Status bits. When this bit becomes set by a Status assignment, then if the mcchsfInfoNotifyPending and/or mcchsfChangeNotifyPending bits are set, the appropriate notifications are fired. | |
| mcchsfUseAoiAsSource | 32 | If set, the sourcerectangle for each source image is the AOI bounds; if the source image is part of a McImageSet or if the McImage.ImageSet property is set, then the McImageSet.Aoi is used. If not set (the default), the source rectangle is the whole of each source image. | |
| mcchsfMaximizeMappedFrames | 64 | This flag affectsdefault destination frame count and the allowed range of aligned mapped frames that can be referenced by the MappedFrameSelector argument to the McColorComposite.DoComposite method. It's interpretation depends on the state of the mcchsfBaseMappedFramesOnSourceFrameCounts flag. When the mcchsfBaseMappedFramesOnSourceFrameCounts bit is clear then if this flag is set then the mapped frame count is the largest adjusted and mapped destination frame for any source. If not set, this frame count is the minimum frame count where all sources'adjusted frame mappings overlap. In this case, negative SourceStartingFrames acts to effectively lengthen the source frame count by prepending with missing frames, while positive SourceStartingFrames acts to effectively shorten the source frame counts by removing frames from the start of the sequence. If the mcchsfBaseMappedFramesOnSourceFrameCounts bit is set then mcchsfMaximizeMappedFrames controls whether the total number of aligned mapped frames is set to the shortest or longest frame count among the sources. In this case, mapped frames always start as if the SourceStartingFrames were set to zero, so if SourceStartingFrames are nonzero frames from some or all of the sources may be missing at the start or end of the mapped frames. Whichever state the mcchsfBaseMappedFramesOnSourceFrameCounts, the two element of the MinAndMaxMappedFrameCounts array returned by McColorComposite.GetSourcesInfo give the mapped frame counts with the mcchsfMaximizeMappedFrames bit clear or set, respectively. And in any case, the length of a created destination image may be overridden by the MappedFrameSelector or DestSelector. | |
| mcchsfInterpolateBinningCorrection | 128 | If set, sourcesare interpolated when magnified for binning correction. | |
| mcchsfBlinkingEnabled | 256 | If set, sourceblinking is enabled for preview display. The blink rate is determined by the McCompositeHost.BlinkRate property. The sources that will blink are those that have the McCompositeHost.SourceStatus mcchssfBlink bit set. | |
| mcchsfBWTrueRangeDest | 512 | If set, thedestination McImage.LookupTable.BlackLevel and McImage.LookupTable.WhiteLevel are assigned their true range extremal values in the destination rectangle. For the changed black/white level to display you must call McImage.LookupTable.Realize. If the flag is not set, the black/white levels are left undisturbed. | |
| mcchsfCreate8BitDest | 1024 | If set, thecomposite image is created as an 8-bit RGB image. If not set, then the composite image is created with the largest bit depth of any of the Sources. | |
| mcchsfTrackSourceImageSet | 2048 | If set, and theMcCompositeHost.SourceImageSet property is not Nothing, then properties of the SourceImageSet are monitored so that the McCompositeHost properties reflect changes in the McImageSet. If the flag is clear, then McImageSetProperties do not track changes in SourceImageSet properties. | |
| mcchsfBaseMappedFramesOnSourceFrameCounts | 4096 | This flag affectsthe interpretation of the mcchsfMaximizeMappedFrames Flag. When this bit is set, mcchsfMaximizeMappedFrames controls whether the total number of aligned mapped frames is set to the shortest or longest frame count among the sources. In this case, mapped frames always start as if the SourceStartingFrames were set to zero, so if SourceStartingFrames are nonzero frames from some or all of the sources may be missing at the start or end of the mapped frames. If this flag is clear, then with mcchsfMaximizeMappedFrames set the mapped frames cover the full range of frames taking into account SourceStartingFrames (frames from all sources may not be available at the start and/or end of the mapped frame locations). With this flag clear and mcchsfMaximizeMappedFrames clear, then only the frames where all sources are available are in the mapped frames. | |
| mcchsfChangeNotifyPending | 1048576 | If themcchsfUpdateEnabled Status bit is clear, then property assignments that change only the contents of the color composite result, but not its size or type, cause this Status bit to be set. The bit is cleared whenever a SNC_NOTIFY_MCDIBACCESS_DATACHANGED notify is fired. | |
| mcchsfInfoNotifyPending | 2097152 | If themcchsfUpdateEnabled Status bit is clear, then property assignments that change its size or type of the color composite result cause this Status bit to be set. The bit is cleared whenever a SNC_NOTIFY_MCDIBACCESS_INFOCHANGED notify is fired. | |
| mcchsfLutNotifyPending | 4194304 | If themcchsfUpdateEnabled Status bit is clear, then property assignments that change the DestLookupTables of the color composite result cause this Status bit to be set. The bit is cleared whenever a SNC_NOTIFY_MCDIBACCESS_SOURCE_DISPLAYLUT notify is fired. | |
| mcchsfActiveFrameNotifyPending | 8388608 | If themcchsfUpdateEnabled Status bit is clear, then changes in the ActiveFrame of the color composite preview cause this Status bit to be set. The preview ActiveFrame changes when The mcchsfTrackSourceImageSet Status bit is set, there is a SourceImageSet and its current location is changed via a McImageSet.SetCurrentLocation call. The bit is cleared whenever a SNC_NOTIFY_MCDIBACCESS_ACTIVEFRAMECHANGED notify is fired. | |
| mcchsfEmptyIntersection | 16777216 | If set there areeither no valid sources or two or more of the offset sources do not overlap. | |
| mcchsfImageSetError_NotComplete | 33554432 | ThemcchsfTrackSourceImageSet Status bit is set but the SourceImageSet does not hold a complete set of frames (See McImageSet.IsComplete). No composite can be done in this case. | |
| mcchsfImageSetError_NotLoaded | 67108864 | ThemcchsfTrackSourceImageSet Status bit is set but the SourceImageSet is not loaded (See McImageSet.IsLoaded). No composite can be done in this case. | |
| mcchsfImageSetError_ColorChannel | 134217728 | ThemcchsfTrackSourceImageSet Status bit is set and one or more of the SourceImageSet's image channels is not a monochrome image. No composite can be done in this case. | |
| mcchsfImageSetError_MixedPixelTypes | 268435456 | ThemcchsfTrackSourceImageSet Status bit is set and one or more of the SourceImageSet's image channels has frames that differ in pixel bit-depth and/or pixel type (integral vs. floating point). No composite can be done in this case. | |
| mcchsfImageSetError_Misc | 536870912 | ThemcchsfTrackSourceImageSet Status bit is set but accessing required composite properties from the SourceImageSet fails. No composite can be done in this case. | |
| mcchsfAllFlags | -1 | All flags. |
See Also