| Customize Help
| Save Settings

MedgeMask


Function Map
Syntax
Description
Parameters
- ContextId
- MaskImageId
Table: For the identifier of the image buffer
- ControlFlag
Compilation information
Synopsis
Mask regions of the Edge Finder context.
Syntax
void MedgeMask(
MIL_ID ContextId, //in
MIL_ID MaskImageId, //in
MIL_INT64 ControlFlag //in
)
Description

This function allows you to set a mask for an Edge Finder context. The mask is applied to the image that uses the context. Subsequent calls to MedgeCalculate() will therefore extract edges only in the context's unmasked regions.

You can also mask edges during post-calculation. In this case, masked edges are excluded from the result buffer and subsequent calculations. Note that partially masked edges are cropped.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ContextId

Specifies the Edge Finder context in which to set the mask. The Edge Finder context must have been previously allocated on the required system using MedgeAlloc().

MaskImageId

Specifies the identifier of the image buffer used to identify the masked pixels in the Edge Finder context.

function map For the identifier of the image buffer
Click to summarizeValue Description
Click to summarize M_NULL

Specifies to ignore this parameter. This parameter must be set to M_NULL when removing the mask.

(summarize)
Click to summarize MIL image buffer identifier

Specifies the image buffer to use as a mask. If the size of the mask image is greater than the source image, the mask will be clipped.

A masked pixel corresponds to a non-zero value in the mask buffer. Note that this buffer can be calibrated; however, this is not necessary, since the mask is applied on a pixel basis.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

(summarize)
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information
Header Include mil.h.
Library Use mil.lib; miledge.lib.
DLL Requires mil.dll; miledge.dll.
NULL PROC NONE