Click or drag to resize

ImageOperatorsAoi Method

A read-only property giving the current area-of-interest (AOI)

Namespace:  MediaCy.IQL.Operators
Assembly:  MediaCy.IQL.Operators (in MediaCy.IQL.Operators.dll) Version: 3.1.0.0
Syntax
VB
Copy
<ExtensionAttribute>
Public Shared Function Aoi ( 
	image As McImage
) As McRegions

Parameters

image
Type: MediaCy.IQL.EngineMcImage

Return Value

Type: McRegions

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type McImage. 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
The image Aoi property is used to restrict many operations to only those pixels that are under or interior to the region feature(s) that make up this property. An AOI can consist of one or more region-defining features, rectangular (McRegions.SetBox), elliptical (McRegions.SetEllipse) or polygonal (McFeatures.SetFeaturePoints). If the Aoi object has a Count of zero (IsReset, see notes) then the entire image is assumed to be the AOI. The McImage.Aoi always exists and it is a read-only property, so to change it you cannot just assign a new McRegions object. Instead you need to use appropriate feature setting methods or use the CopyFrom method to import an AOI from the AoiList.
Note Note
If the Aoi is empty, then it is forces to be IsReset as well, because the mcofOneFeatureOnly OptionFlags is always set for Aoi-type McRegions.
Examples
VB
Copy
' Set the ThisApplication.ActiveImage AOI to a single 200 by 100 rectangular area
ThisApplication.ActiveImage.Aoi.Reset 'clear any existing AOI
'Set the McRegions feature 0 to a box
ThisApplication.ActiveImage.Aoi.SetBox 0, 10, 10, 209, 109 '200 by 100 pixels under the AOI
See Also