mcCompositeControlFlags Enumeration

Legal bit values for the McColorComposite.DoCompositeControlFlags argument.

Namespace: MediaCy.IQL.Operations
Assembly: MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0

Syntax

Copy

Public Enumeration mcCompositeControlFlags

Members

Member name	Value	Description
mcccfNoFlags	0	No flags. This is the defaultfor the ControlFlags argument. It results in the source and destination both being the whole image rather than the AOI bounds. Source magnifications are not interpolated. If there are previously cached intermediate results, they are used if possible, but newly created intermediate results are not saved. Intermediate images are not visible.
mcccfDestCreationOptions	3	mask for the destination imagecreation options. Applied if no DestImage is supplied, there is no ancestor McImage or the mcccfForceDestCreation bit is set.
mcccfCreateFullCoverage	0	IfMcColorComposite.DoComposite creates the destination image, it is made large 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.
mcccfCreateIntersection	1	If a destination image iscreated, the image is created 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 intersection is empty (i.e., McColorComposite.GetSourcesInfo return value has the mccpfEmptyIntersection flag set), then an error is generated.
mcccfCreateSmallest	2	IfMcColorComposite.DoComposite creates the destination image, it is made the same size as the smallest source. The DestOffsetXY and SourceOffsetsXY are applied, so that some of the combine may be clipped.
mcccfCreateLargest	3	IfMcColorComposite.DoComposite creates the destination image, it is made the same size as the largest source. The DestOffsetXY and SourceOffsetsXY are applied, so that some of the combine may be clipped.
mcccfCreateHonorsDestRect	4	If McColorComposite.DoCompositecreates the destination image (that is, no DestImage is supplied, there is no ancestor McImage or the mcccfForceDestCreation bit is set) and a DestRect is supplied, then the created image is made the same size as the DestRect argument. In this case, the mcccfDestCreationOptions masked value ignored. The DestOffsetXY and SourceOffsetsXY are applied, so that some of the combine may be clipped.
mcccfCreateDestVisible	8	If McColorComposite.DoCompositecreates the destination image (that is, no DestImage is supplied, there is no ancestor McImage or the mcccfForceDestCreation bit is set), then it is made visible. This has the same effect as assigning the Visible property of the McImage returned from DoComposite True; by default it is False. See also mcccfDebugShowIntermediateImages
mcccfForceDestCreation	16	If set, the destinationimage is always created when McColorComposite.DoComposite is called. If not set, then the destination image is created only if the DestImage argument is not given and if the McColorComposite operator has no ancestor McImage.
mcccfMaximizeMappedFrames	32	This flag affects thedefault 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 mcccfBaseMappedFramesOnSourceFrameCounts flag. When the mcccfBaseMappedFramesOnSourceFrameCounts 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 mcccfBaseMappedFramesOnSourceFrameCounts bit is set then mcccfMaximizeMappedFrames 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 mcccfBaseMappedFramesOnSourceFrameCounts, the two element of the MinAndMaxMappedFrameCounts array returned by McColorComposite.GetSourcesInfo give the mapped frame counts with the mcccfMaximizeMappedFrames bit clear or set, respectively. And in any case, the length of a created destination image may be overridden by the MappedFrameSelector or DestSelector.
mcccfUseAoiAsSource	64	If set, the source rectanglefor each source image is the AOI bounds. If not set (the default), the source rectangle is the whole of each source image.
mcccfUseAoiAsDest	128	If set, the destinationrectangle for the composite combine in the destination image is its AOI bounds. If not set (the default), the destination rectangle is the whole of the destination image. Also, if this flag is set and the destination image has an irregular AOI, the combine is masked so that changes are made only to destination pixels within the AOI regions.
mcccfOnlyFullIntersection	256	If set andMcColorComposite.DoComposite creates the destination image, then the image is created so that the combine is done only where the all offset source rectangles overlap. If not set, the created destination image encompasess all of the offset source images. In this case or if a destination image is supplied, the combine is done at each destination pixel with as many source images as are available at that pixel. If this flag is set and the intersection is empty (i.e., McColorComposite.GetSourcesInfo return value has the mccpfEmptyIntersection flag set), then an error is generated.
mcccfInterpolateIfMagnified	512	If set, then along anydimension where a source is magnified (i.e., where the McColorComposite.DoComposite SourceMagnificationsXY argument is greater than 1), then the expanded source values are linearly interpolated between the nearest pixels. If clear then during expansion, replication of the nearest pixel is used without interpolation. Irrespective of the state of this flag, if the magnification is less than 1 then the nearest pixel is used without interpolation or averaging.
mcccfCacheResults	1024	If set, then intermediateresults for source frames are cached when McColorComposite.DoComposite is called. If this bit is clear, then any previously cached intermediate results are used if possible, but newly created intermediate results are not saved. Cached results must be explicitly discarded by a call to the McColorComposite.FreeCaches method if they become invalid due to a changed lookup table, since the lookup table is not tested as part of determining if a cache is still valid. When this bit is set and the mcccfKeepUnusedCaches bit is not set, then any cached frames that are not used during the McColorComposite.DoComposite execution are freed (see mcccfKeepUnusedCaches).
mcccfKeepUnusedCaches	2048	Normally, if themcccfCacheResults bit is set, then any intermediate frame caches that are not used during McColorComposite.DoComposite execution are freed. However if the mcccfKeepUnusedCaches bit is set, then these caches are kept.
mcccfCreate8BitDest	4096	If set, whenMcColorComposite.DoComposite needs to create a color triplet destination image (because the McColorComposite instance has no ancestor McImage and no DestImage parameter is supplied) then the image will be created with 8-bits per color channel. If clear, then the created image will have a bit-depth per color channel equal to the maximum bit-depth of all sources.
mcccfCreateDibDest	8192	If set, whenMcColorComposite.DoComposite needs to create an 8-bit color triplet destination image, then the it will be created as a standard 24-bit BGR reverse raster DIB. Such images display faster than other organizations. If clear, then 8-bit images are created with a 24-bit RGB flat file organization; such images can have better performance when GetArea is called and for some other types of image processing. An 8-bit per color destination image is created when the McColorComposite instance has no ancestor McImage, no DestImage parameter is supplied by the caller and either mcccfCreate8BitDest bit is set or the the maximum bit-depth of all sources is 8-bits.
mcccfBWTrueRangeDest	16384	If set,McColorComposite.DoComposite assigns the destination McImage.LookupTable.BlackLevel and McImage.LookupTable.WhiteLevel to 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.
mcccfCreateMultiBandDest	32768	If set, the destination image iscreated as a mcInterpretation.mciGenericMultiBand Type image. In this case, the SourceColors argument to McColorComposite.DoComposite is completely ignored and each monochrome source is placed in one band of the destination multiband image, in the order that the sources appear in the Sources argument. DoComposite arguments other than SourceColors are not ignored; in particular, offsets, magnifications and, if mcccfNoScaleBands is not set, source lookup tables are all applied to the source images before they are combined into the multiband destination image. If this bit is set, the mcccfCreateDibDest bit is ignored.
mcccfNoScaleBands	65536	If set and themcccfCreateMultiBandDest is also set, then the bands of the destination mcInterpretation.mciGenericMultiBand image. are not scaled to all map onto the same RangeMin/RangeMax. Instead the destination image is created with the largest bit-depth of any of the sources and the values placed in each band is the raw source value. If any of the sources is a floating point mcPixelDataType.mcpdtFloat Type, then the destination is created as a mcPixelDataType.mcpdtFloat Type with RangeMin and RangeMax set so that it encompasses the RangeMin/RangeMax of all of the sources. When this bit is set, the lookup tables are ignored as is the mcccfCreate8BitDest.
mcccfBaseMappedFramesOnSourceFrameCounts	131072	This flagaffects the interpretation of the mcccfMaximizeMappedFrames Flag. When this bit is set, mcccfMaximizeMappedFrames 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 mcccfMaximizeMappedFrames 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 mcccfMaximizeMappedFrames clear, then only the frames where all sources are available are in the mapped frames.
mcccfDebugShowIntermediateImages	268435456	If set,intermediate images created by McColorComposite.DoComposite are named, made visible and part of the Images collection. In addition, any destination image created by the call will also be named, visbile and part of the Images collection. This can be useful for debugging purposes. If clear, then intermediate and created destination images are unnamed, not visible and not part of the Images collection. See also mcccfCreateDestVisible.
mcccfNoMessageDischarge	536870912	If set, nomessage loop discharge, progress meter update or user escape checks occur during a McColorComposite.DoComposite. If not set, then all of these actions are performed. This bit should be set only when it is known that the operation can be performed in a timely manner.

Reference

MediaCy.IQL.Operations Namespace