Differences

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

--- en:code:core:image [2012/12/13 12:59] – michel
+++ en:code:core:image [2023/10/09 10:17] (current) – jmgr
@@ Line 16: / Line 16: @@
 <code javascript>
 var myObject = new Image(filename);
-</code>
-<code javascript>
-var myObject = new Image(x, y);
 </code>
@@ Line 54: / Line 51: @@
 === Exceptions ===
   * (InvalidWindowError) invalid window
+==== takeScreenshotUsingScreenIndex ====
+Take a screenshot of one screen and store the result in a new Image. [//Added in Actionaz 3.7.0.//]
+=== Syntax ===
+<code javascript>
+var myObject = Image.takeScreenshotUsingScreenIndex(0);
+</code>
+=== Arguments ===
+  - screenIndex - (integer) the index of the screen to screenshot
+=== Exceptions ===
+  * (InvalidScreenIndexError) invalid screen index
 ===== Methods =====
@@ Line 357: / Line 368: @@
     * confidenceMinimum - (integer) the minimum confidence percentage, 100 means perfect match (default: 70)
     * downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
-    * searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
+    * method - ([[#method|Method]]) the search method to use (default: CorrelationCoefficient) [//Added in Actionaz 3.7.0.//]
 === Returns ===
@@ Line 401: / Line 412: @@
     * searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
     * maximumMatches - (integer) the maximal number of matches (default: 10)
+    * method - ([[#method|Method]]) the search method to use (default: CorrelationCoefficient) [//Added in Actionaz 3.7.0.//]
 === Returns ===
@@ Line 417: / Line 429: @@
 var imageToFind = new Image("object.png");
-var searchResult = screenShot.findSubImage(imageToFind);
+var searchResult = screenShot.findSubImages(imageToFind);
 if(searchResult)
 {
@@ Line 452: / Line 464: @@
     * downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
     * searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
+    * method - ([[#method|Method]]) the search method to use (default: CorrelationCoefficient) [//Added in Actionaz 3.7.0.//]
 === Returns ===
@@ Line 497: / Line 510: @@
     * searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
     * maximumMatches - (integer) the maximal number of matches (default: 10)
+    * method - ([[#method|Method]]) the search method to use (default: CorrelationCoefficient) [//Added in Actionaz 3.7.0.//]
 === Returns ===
@@ Line 553: / Line 567: @@
   - Vertical: a vertical mirror
   - Horizontal: an horizontal mirror
+==== Method ====
+Search method. [//Added in Actionaz 3.7.0.//]
+=== Values ===
+  - CorrelationCoefficient: correlation coefficient, best for most use cases
+  - CrossCorrelation: cross correlation
+  - SquaredDifference: squared difference