Click or drag to resize

ImagesOperatorsMemoryAutoLockLimit Method (McImages)

The percentage of physical memory automatically locked for each McRegionAccess instance.

Namespace:  MediaCy.IQL.Operators
Assembly:  MediaCy.IQL.Operators (in MediaCy.IQL.Operators.dll) Version: 3.1.0.0
Syntax
VB
<ExtensionAttribute>
Public Shared Function MemoryAutoLockLimit ( 
	images As McImages
) As Double

Parameters

images
Type: MediaCy.IQL.EngineMcImages

Return Value

Type: Double

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type McImages. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
When an image frame is accessed for analysis, normally only a very small portion of it needs to be guaranteed locked into memory. However, after one image access a known portion of the image will very likely need to be accessed soon (i.e., normally the entire McRegionAccess ROI will be traversed). The McRegionAccess.TraversalMode allows specification of how this traversal will happen, and the MemoryAutoLockLimit property sets a limit on how much extra image memory is automatically locked to optimize that traversal. By default, MemoryAutoLockLimit is set to 2 percent of the MemoryUsageLimit. The default value is pretty conservative, but in some special case where you expect to have many (6 or more) large image frames being accessed simultaneously you might want to make the value smaller to avoid unnecessarily swapping to disk. Alternately, if you are doing image processing on only one or two very large frames at a time, you might avoid unnecessary disk swapping or memory reallocations by making the value larger (10 might be reasonable values in these cases), however auto locking is never allowed use more than one half of the MemoryUsageLimit bytes.
See Also