Click or drag to resize

mcMcImageSetCommandFlags Enumeration

Predefined flags and command codes for the IMcImageSet2.CommandFlags property and IMcImageSet2.DoCommand ActionCommand parameter.

Namespace:  MediaCy.IQL.Sets
Assembly:  MediaCy.IQL.Sets (in MediaCy.IQL.Sets.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcMcImageSetCommandFlags
Members
  Member nameValueDescription
mcmiscfNoFlags0No flags.
mcmiscfSetSpatialCalib256Action flag: assign CommandData asthe McImageSet.SpatialCalib property.
mcmiscfFlushUndoStack257Action flag: McImageSet.UndoStackand all source McImage.UndoStack are flushed.
mcmiscfLastExposeAsImageState258Action flag: On exit,CommandData is filled with a mcExposedImageStateEnum value giving the state of the most recent call to McImageSet2.ExposeAsImage. In particular, this can be used after an error return from that method to determine why the call failed. It can also be used to determine why an attempt to set the mcImageSetState.mcissCollapseScanAndResDims IMcImageSet2.ImageSetState flag failed.
mcmiscfLastBadTilingFrameCount259Action flag: On exit, CommandDatais filled with a frame count where there was problematic tiling during the last call to McImageSet2.ExposeAsImage or during setting of the mcImageSetState.mcissCollapseScanAndResDims IMcImageSet2.ImageSetState flag.
mcmiscfLastTilingStatistics260Action flag: On entry ifCommandData is not empty, it should hold a Resolution index; if empty, resolution zero is assumed. On exit, CommandData is filled with an array of Double tiling statistics from the most recent call to McImageSet2.ExposeAsImage (with the mcExposeAsImageCreationFlags.mceascfDoNotCollapseDims flag clear) or during setting of the mcImageSetState.mcissCollapseScanAndResDims IMcImageSet2.ImageSetState flag. The statistics values reported are as follows: MaxScanTiles - Maximum number of scan tiles in any frame MinScanTiles - Minimum number of scan tiles in any frame MaxTileWidth - Maximum tile width in any frame MaxTileHeight - Maximum tile height in any frame MinTileWidth - Minimum tile width in any frame MinTileHeight - Minimum tile height in any frame PercentFramesWithPerfectTiling - Percentage of frames with perfect tiling (complete coverage with no overlap) PercentFramesWithOverlap - Percentage of frames with at least some tile overlap (frames with no overlap may not be perfectly tiled if they have gaps between them) MaxShortOverlapSide - Maximum length (in pixels) on the short side of any overlap (a measure of tile pixel alignment overlap) MaxOverlapPercent - Maximum tile overlap area as a percentage of the largest tile. (maximum for all frames) AvgOverlapPercent - Average tile overlap area as a percentage of the largest tile aea. (Average for all frames with any overlap). TilesThatOverlap - Average number of tile pairs that overlap (Average for all frames with any overlap). TilesThatOverlapAsPercentOfPossible - Count of tile pairs that overlap as a percentage of all possible overlap pairs (Average for all frames with any overlap) AddedOffsetX - Horizontal pixel offset of tiled frames from their natural origin AddedOffsetY - Vertical pixel offset of tiled frames from their natural origin AddedExpansionX - Horizontal added pixels of tiled frames from their natural width AddedExpansionY - Vertical added pixels of tiled frames from their natural height AvgTilesToBoundsAreaRatio - 1.0 for perfect tiling, >1.6 for ExcessiveOverlap, <0.05 for Sparse Coverage. Average for all frames. AvgEmptyGridElementsPercentage - % of empty tile-sized grid elements. Average for all frames. NumberOfFramesInRegion - Total number of frames in the collapsed region NumberOfSparseCoverageFrames - Frames with sparse coverage (if more than 1/3 initialization will fail) NumberOfExcessiveOverlapFrames - Frames with excessive overlap (if more than 1/3 initialization will fail) NumberOfClusteredCoverageFrames - Frames with Clustered Coverage (EmptyGridElementsPercentage >33%). Suspicious, but not necessarily a bad tiling.
mcmiscfIsPixelDataModified261Action flag: . On exit,CommandData will be a Boolean value, which will be True if any of the image set's source images have had their pixel data modified since the last time that either their individual McImage.Modified or the McImageSet.Modified was assigned False. If no such pixel data change has been made then the returned CommandData will be False.
mcmiscfGetAssociationOrderedRegion262Action flag: This action flagcomputes an appropriate ordered McImageSetRegion for this McImageSet (Operand1) to associate with a second (Operand2) McImageSet or McImage where the selected frames of Operand2 may be reused to associate with all of the selected frames in this, Operand1, McImageSet. On entry, CommandData is to be either a scalar Object or an Array of one to three Objects. The first element is the Operand2 to be associated and is always either a McImage or a McImageSet. The second element if it is present and not Empty, must be a McImagSetRegion describing the Region in this McImageSet (Operand1) to be associated with; if it is missing, then Me.GetRegionToProcess is used. The third element is ignored if Operand2 is not a McImageSet. If the third element is present and not Empty, it must be a McImagSetRegion describing the Region in Operand2 to be associated with this McImageSet; if it is missing, then Operand2.GetRegionToProcess is used. If Operand2 is a McImage then the McImage.UseActiveFrameRange and ActiveFrameRange properties are used to determine how many frames are available to associated. Typically, on entry CommandData will just be a scalar Operand2 object for the usual case where GetRegionToProcess provides the proper selected region for both operands. The frame association rules are as follows: 1. If the Operand2 frames resolve to a single frame then the selected Operand1 frames can be processed in any dimension order. 2. If Operand2 is a multi-frame sequence then it will associate only with Operand1 where only one dimension is selected and the selected length of that dimension is the same as the Operand2.FrameCount. If Operand1 has more than one selected dimension with non-zero extent, no association is allowed. 3. If Operand2 is a McImageSet then selected dimensions in Operand2 must have only a single location selected or the selected extent of a dimension must match the selected extent of the corresponding Operand1 dimension. If these conditions are not met then no association is allowed. On exit, CommandData will be either Empty, which which indicates that the association is not allowed. Or CommandData will be an instance of McImageSetRegion with the order in which McImageSetSection instances were added to the result McImageSetRegion.Sections indicates the dimansion ordering of Operand1 (this McImageSet) required to associate correctly with an unordered Operand2. CommandData will be cleared after it is accessed so it is important to immediately retrieve the result McImageSetRegion instance.
mcmiscfCanAssociateOrderedRegion263Action flag: This action flagdoes the same test as the mcmiscfGetAssociationOrderedRegion action flag. However, instead of returning with CommandData filled with a McImageSetRegion instance, it returns with CommandData either True or False. The result will be True if the association argument(s) supplied in CommandData, as described for the mcmiscfGetAssociationOrderedRegion flag, is a legal association. In this case, a subsequenct mcmiscfGetAssociationOrderedRegion call with the same CommandData input arguments will return a ordered McImageSetRegion in CommandData. If False, then a subsequenct mcmiscfGetAssociationOrderedRegion call with the same CommandData input arguments would return an empty CommandData. For this flag, CommandData will not be cleared after it is accessed.
See Also