User Tools

Site Tools


en:actions:actionfindimage

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:actions:actionfindimage [2016/10/09 09:10]
en:actions:actionfindimage [2020/02/09 13:26] (current)
Line 1: Line 1:
 +====== Find image ======
  
 +This action allows you to search for an image on the screen, within a window or within another image.
 +
 +[//Added in Actionaz 3.2.0.//]
 +
 +===== Standard parameters =====
 +==== Input parameters ====
 +== Source ==
 +The source of the image where to search.
 +  * Screenshot (search on the screen)
 +  * Window (search on a window)
 +  * Image (search in another image)
 +== Window name ==
 +The title of the windows where to search.
 +You can use wildcards here like * (any character) or ? (one character).
 +== Window relative position ==
 +The position is relative to the window.
 +If this parameter is set to false (not checked) then the position is absolute.
 +== Image to search in ==
 +The path of the image where to search.
 +== Image to find ==
 +The path of the image to find.
 +== If found ==
 +What to to if the image has been found. [//Added in Actionaz 3.7.0.//]
 +== If not found ==
 +What to to if the image has not been found. [//Added in Actionaz 3.7.0.//]
 +==== Output parameters ====
 +== Position ==
 +The name of the variable where to search for the image.
 +If the image cannot be found an exception is triggered.
 +
 +===== Advanced parameters =====
 +==== Input parameters ====
 +== Method ==
 +The search method to use.
 +== Confidence minimum ==
 +The minimum confidence percentage required to select a possible matching image.
 +== Maximum matches ==
 +The maximum matching images count.
 +Setting this parameter higher will increase the duration of the search.
 +== Downsampling ==
 +(was "down pyramid count" before Actionaz 2.7.0)
 +
 +The downsampling value to use. 1 should work with every image. Choose 2 here if the image to search into is very large to accelerate the search.
 +== Search expansion ==
 +The number of pixels to shift when searching for another matching image.
 +== Delay between two searches when waiting ==
 +The amount of time to wait between to image searches when waiting for an image to appear or disappear. [//Added in Actionaz 3.7.0.//]
 +
 +==== Output parameters ====
 +== Confidence ==
 +The confidence percentage of the found image. [//Added in Actionaz 3.7.0.//]
 +===== Exceptions =====
 +
 +  * [[en:​actions:​exceptions#​Bad parameter|Bad parameter]]
 +  * [[en:​actions:​exceptions#​Code error|Code error]]
 +  * [[en:​actions:​exceptions#​timeout|Timeout]]
 +  * [[en:​actions:​actionopenurl#​errorwhilesearching|Error while searching]]
 +  * [[en:​actions:​actionopenurl#​cannotfindimage|Cannot find the image]]
 +
 +==== Error while searching ====
 +<​BOOKMARK:​errorwhilesearching>​
 +
 +This exception is thrown when an error occured while searching.
 +  * Default action: stop the script execution
 +
 +==== Cannot find the image ====
 +<​BOOKMARK:​cannotfindimage>​
 +
 +[//Removed in Actionaz 3.7.0.//]
 +
 +This exception is thrown when the image cannot be found.
 +  * Default action: stop the script execution