FindImageOptions

image FindImageOptions

Options for template locate (findImage, etc.): similarity threshold, pyramid level, and optional ROI.

Table of contents

Properties

• threshold
• level
• region

Properties

threshold

• threshold?: number

Similarity cutoff in [0, 1]. Higher = stricter. If omitted, a default is inferred from image size (runtime-specific).

level

• level?: number

Pyramid depth for coarse-to-fine search—larger values speed up wide searches but may miss fine details. Use MAX_LEVEL_AUTO (-1) to pick automatically.

region

• region?: Region

Restrict search to a rectangle; omit to scan the entire haystack image.