The AutoSelectImageVariant method uses a specified color (RGB value), compares this value to pixels in the image and selects areas of the image that have that color. From this selection, the AutoSelectImage method creates a new image and mask image.
Parameters
| Name | Explanation |
|---|---|
| x | An array of x coordinate values defining points of a polygonal area on the image. (in pixels) * (see Note below) |
| y | An array of y coordinate values defining points of a polygonal area on the image. (in pixels) * (see Note below) |
| Red | Specifies the red value of the color that will be selected (From 0 to 255) |
| Green | Specifies the green value of the color that will be selected (From 0 to 255) |
| Blue | Specifies the blue value of the color that will be selected (From 0 to 255) |
| Mode | Comparison mode (0:RGB, 1:CrCb, 2:Y) |
| Level | Level of Allowance (From 0 to 255) |
| * NOTE for retrieving array values: In Visual Basic / VB.NET, if the array is defined as Dim x(0 To 2), then the arguments are returned in x. In C#.NET the arguments are returned in ref x. |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The AutoSelectImageVariant method uses a specified color (RGB value), and selects areas of the image that have that color.
This method is recommended when using scripting or other languages that require variant types or when using 64 bit builds in VB.NET or C#.
To execute the AutoSelectImageVariant method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The AutoSelectImageVariant method supports 1, 4, 8, 16, 24, and 32 bit images.
Before executing the AutoSelectImageVariant method, you must set the area on the image that will be affected. There are 4 ways to do this.
- To use a mask image, set the SelectMode property to 0. Set the mask image handle in the MaskImageHandle property
- To process the total image, set the SelectMode property to 1
- To process the polygonal area on the image, set the SelectMode property to 2. Select the polygon by setting the appropriate coordinate values for the points of the polygon in two arrays, one array for the x coordinate values and one array for the y coordinate values. The pass these arrays to the x and y arguments of the AutoSelectImageVariant method. The number of points defining the polygon must be 3 or more
- To process an elliptical area on the image, set the SelectMode property to 3. Select the ellipse by setting the appropriate values for the bounding rectangle in the RectLeft, RectTop, RectRight, and RectBottom properties
Note: When the SelectMode property is set to values other than 2 (ikEffectPolygon), please set dummy arrays in the x and y parameters.
The Mode parameter sets the type of color comparison used to select portions of the image. When the Mode parameter is other than 0 (i.e. CrCb or Y) then all RGB values are converted to YCrCb values and compared. The Level parameter controls the range of RGB values that will be selected. If the Level value is 0, then only those pixels that have the save RGB value as that specified in the Red, Green, and Blue parameters will be selected. As the Level parameter increases, the range of RGB values that will be selected increases. For example, if Level = 10 and Red, Green, and Blue = 100 respectively, then all pixels with an RGB value between (90,90,90) and (110,110,110) will be selected.
If successful the resulting raster image data is set in the LayerNo property (the ImageHandle property or the Layer(LayerNo).ImageHandle property. If unsuccessful, 0 is returned.
When the Caption, Message, and ButtonName properties are blank, the progress dialog box will not be displayed. When the progress dialog box is displayed, the percentage that the processing has completed will be shown in the dialog box.
Also see the AutoSelectImage method.