Click or drag to resize

mcImageCreateFlags Enumeration

Image creation flags.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcImageCreateFlags
Members
  Member nameValueDescription
mcicfDefault0No flags are set. The image iscreated with each frame allocated its own memory block. Memory is uninitialized. The image is added to the Images collection and is made visible. An opened image is savable and the loading of frame data may be deferred until it is accessed. The system calibration(s) are not applied.
mcicfContiguous1If set, frames are allocatedinto a single, contiguous block of memory. In this case you cannot call McImage.AddFrames to add to the McImage.FrameCount at a later time. If not set (the default case), frames are grouped to use memory efficiently without too much wasted space. This flag is generally only absolutely needed for certain hardware mapped images, and should be avoided otherwise.
mcicfNoInit2Default is to initialize newframe pixels to 0 (black), this flag suppresses this initialization. If the mcicfNoInit flag is set, the initial state of frame memory is undefined, which is appropriate if you are planning to write to the frame immediately. This flag has no effect when images are being opened or being created by some image processing operation.
mcicfNoAddToCollection4If set, the image is created,but not added to the Images collection. This flag has an effect only if the mcicfNotVisible flag is also set, because all visible images are part of the Images collection.
mcicfNotVisible8If set, the image is created,added to the Images collection if the mcicfNoAddToCollection flag is clear, but is not made visible. The image may be made visible at a later time by setting the McImage.Visible property True. If this flag is not set (the default case), then the image is always added to the images collection (any mcicfNoAddToCollection flag is ignored) and then made visible. All visible images are part of the Images collection.
mcicfApplySystemCalib16If set, the current systemcalibration(s) will be applied to the image. It should usually only be set if the image is captured.
mcicfReadOnly32If set during a McImages.Openoperation, the source image file will be locked for writing for the life of the image, and any attempted McImage.Save will fail. It is usually (see mcicfOnDiskImageData) still possible to modify the image and/or its properties, but to save such changes a McImage.SaveAs operation must be made to save the image to a file other that its original source file (which will still be locked). Some image file types are inherently read-only in that support for writing images of that type is not available.
mcicfDelayLoadingFrames64If set during a McImages.Openoperation, frame loading may be deferred until a frame is accessed for viewing or processing. In this case, the source image file will be locked for writing, with one exception, for the life of the image. The exception is that once all frames have been loaded, the image file will become writable unless the mcicfReadOnly flag set. If the flag is clear (the default case), then all frames in the image are forced to be loaded during the open. Warning: the value of this flag is the same as mcicfUnWeightedMonoCast, which is used only with image conversion and copy methods, never with McImages.Open.
mcicfUnWeightedMonoCast64Is set in theImageCreationFlags argument of a McImage.Convert, McImage.ConvertEx, McImage.CopyToNewImage or IMcImage2.CopyToNewImageEx call and a cast from RGB or BGR to monochrome is needed, then the conversion will be done using a simple average of the three source color channels. If not set, then a weighted average is done that uses the following weights 0.302 Red, 0.588 Green and 0.110 Blue. Warning: the value of this flag is the same as mcicfDelayLoadingFrames, which is used only with McImages.Open.
mcicfReadPropertiesOnly128If set during aMcImages.Open operation, only image and frame properties are read; no image pixel data is read. If the flag is clear (the default case), both properties and image pixel data are transferred from the McStream into the image file. This flag is used internally and is not normally useful otherwise.
mcicfOnDiskImageData256If set, during aMcImages.Open operation, image data is left in the image file and then loaded into memory and kept there only as needed. The Open will succeed only if the image file McStream has the proper capabilities to suppport this mode. Currently no image file McStream can support writing back to the image file, so the mcicfReadOnly and mcicfNoWriteToImageData flags are implicitly set (supplying these flags explicitly will make this clearer). This flag is usually only set for images with very large frames, so the combination of large pixel array with slow access to image data in the file means that many normal operations are unacceptably slow on such images and need to be handled differently. To accomodate these differences, images opened with the mcicfOnDiskImageData are displayed in a special viewer. If the flag is clear during McImages.Open (the default case), then once a frame from the image file is loaded into memory, it is kept there (or swapped to a temporary file if necessary). Thus frame pixels may be modified in memory, and access to these pixels is likely to be faster. The Open will fail if the image frame is too big.
mcicfNoWriteToImageData512If set then operations thatmodify image data are prohibited. This is not the same as the mcicfReadOnly creation flag, since that only prevents overwriting the original source file, not modifying the image data while it is in memory (e.g., via a filter).
mcicfSuppressEvents1024If set during a McImages.Openor when an image is created by other means, then the IMcImages.BeforeOpen or IMcImages.BeforeNew as well as the IMcImage(s).Open or IMcImage(s).New events are suppressed. This flag is used for internal purposes and should generally be avoided for user-developed code.
mcicfDiscardableImageData2048If clear (the default state),then when image memory is getting full [see McResourceManager.MemoryMax(mcmtImageMemory)], unlocked modified memory for this image may be spooled out to a swap file before freeing the memory for other images. Later, if the image data is needed again, it can be read in from the swap file. If this bit is set, then instead of spooling out the memory, it is just discarded. The IMcImage2.ImageState mcImageStateFlags.mcisfDiscardableImageData flag will be set for images created with the mcicfDiscardableImageData flag set, and the IMcImage2.ImageState mcImageStateFlags.mcisfImageDataHasBeenDiscarded bit will be set if any image data has been discarded. The McImage.PixelBuffer.NextAccessPriorityForDiscard property provides a way to limit the discard to only low-priority frames. Should discarded image memory be accessed later, it will appear as all zero (black) values.
mcipfImportPropertiesMask268431360A mask for themcImportPropertiesFlags, which may be Or'ed with the mcImageCreateFlags for some methods that take a mcImageCreateFlags argument. This value is the same as the mcImportPropertiesFlags.mcipfMask value.
mcipfNoImportProperties268435456Suppress ImportPropertiesfor functions when creating an image from another. All mcImportPropertiesFlags are ignored. No BeforeImportProperties and AfterImportProperties events will be fired and no properties will be copied to the new image. The mcipfNoImportProperties flag is currently supported for the McImage.Duplicate, McImage.Convert, McImage.ConvertEx, McImage.CopyToNewImage or IMcImage2.CopyToNewImageEx methods only.
mcicfNoUserEscape536870912If set in theImageCreationFlags argument of an operation that creates a new image, then the operation cannot be cancelled by the user pressing the Escape key. If not set, then if the operation is taking a long time and the user presses the escape key, the operation will be interrupted. If the operation is interrupted, depending on the state of the mcicfKeepInterruptedResult flag, a mceCANCELLED error may be returned (mcicfKeepInterruptedResult clear). If mcicfKeepInterruptedResult is set then the operation will succeed, but the created image will be only partially filled with result data, and the mcImageStateFlags.mcisfImageCreationInterrupted flag will be set in the IMcImage2.ImageState property. The mcicfNoUserEscape flag is currently supported for the McImage.Duplicate, McImage.Convert, McImage.ConvertEx, McImage.CopyToNewImage or IMcImage2.CopyToNewImageEx methods only.
mcicfKeepInterruptedResult1073741824If set in theImageCreationFlags argument of an operation that the user cancels by pressing the Escape key, then the created image is preserved but will be only partially filled with result data; in this case the mcImageStateFlags.mcisfImageCreationInterrupted flag will be set in the IMcImage2.ImageState property of the new image. If the mcicfKeepInterruptedResult flag is clear and the user cancels the operation, then the operation will fail with a mceCANCELLED error. The mcicfKeepInterruptedResult flag is currently supported for the McImage.Duplicate, McImage.Convert, McImage.ConvertEx, McImage.CopyToNewImage or IMcImage2.CopyToNewImageEx methods only.
Remarks
mcImageCreateFlags also supports the mcImportPropertiesFlags values, which can be used to specify how to import properties when creating an image from another in methods like Convert.
See Also