Differences

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

--- en:code:core:image [2011/11/18 13:05] – [findSubImage] jmgr
+++ en:code:core:image [2023/10/09 10:17] (current) – jmgr
@@ Line 15: / Line 15: @@
 </code>
 <code javascript>
-var myObject = new Image(x, y);
+var myObject = new Image(filename);
 </code>
 === Arguments ===
   - otherImage - (Image) other Image to copy
+  - filename - (string) a valid image filename
 === Exceptions ===
   * (ParameterTypeError) incorrect parameter type
@@ Line 51: / 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 339: / Line 353: @@
 Searches for another image contained in this one.
-Added in Actionaz 3.1.0.
+//Added in Actionaz 3.0.1.//
 === Syntax ===
@@ Line 354: / 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 ===
-  * (object) the matching point, or null if not matching point can be found
+  * (object) the matching point, or null if no matching point can be found
     * position - ([[en:code:core:point|Point]]) the matching image center
     * confidence - (integer) the confidence percentage
@@ Line 379: / Line 393: @@
 ==== findSubImages ====
-Searches for another images contained in this one.
+Searches for images contained in this one.
-TODO
+//Added in Actionaz 3.0.1.//
+=== Syntax ===
+<code javascript>
+myObject.findSubImages(otherImage);
+</code>
+<code javascript>
+myObject.findSubImages(otherImage, options);
+</code>
+=== Arguments ===
+  - otherImage - (Image) the Image to find
+  - options - (object) search options
+    * 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)
+    * 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 ===
+  * (array of objects) the matching points, or null if no matching point can be found
+    * position - ([[en:code:core:point|Point]]) the matching image center
+    * confidence - (integer) the confidence percentage
+=== Exceptions ===
+  * (FindSubImageError) an error occured while searching for a sub-image
+  * (ParameterTypeError) incorrect parameter type
+=== Example ===
+<code javascript>
+//Searches for objects on the screen
+var screenShot = Image.takeScreenshot();
+var imageToFind = new Image("object.png");
+var searchResult = screenShot.findSubImages(imageToFind);
+if(searchResult)
+{
+    Console.print("Matching images found\n");
+    for(var i = 0; i < searchResult.length; ++i)
+    {
+        Console.print("position: " + searchResult[i].position + ", confidence: " + searchResult[i].confidence + "\n");
+    }
+}
+else
+    Console.print("No matching images found.");
+</code>
 ==== findSubImageAsync ====
 Searches for another image contained in this one in asynchronous mode.
-TODO
+//Added in Actionaz 3.0.1.//
+=== Syntax ===
+<code javascript>
+myObject.findSubImageAsync(otherImage, callback);
+</code>
+<code javascript>
+myObject.findSubImageAsync(otherImage, callback, options);
+</code>
+=== Arguments ===
+  - otherImage - (Image) the Image to find
+  - callback(object) - (function) the function that will be called when the search ends
+    * position - ([[en:code:core:point|Point]]) the matching image center
+    * confidence - (integer) the confidence percentage
+  - options - (object) search options
+    * 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 ===
+  * (Image) this Image
+=== Exceptions ===
+  * (FindSubImageError) an error occured while searching for a sub-image
+  * (ParameterTypeError) incorrect parameter type
+=== Example ===
+<code javascript>
+//Searches for an object on the screen
+var screenShot = Image.takeScreenshot();
+var imageToFind = new Image("object.png");
+screenShot.findSubImageAsync(imageToFind, function(searchResult)
+{
+    if(searchResult)
+        Console.print("Matching image found, position: " + searchResult.position + ", confidence: " + searchResult.confidence);
+    else
+        Console.print("No matching image found.");
+});
+</code>
 ==== findSubImagesAsync ====
-Searches for another images contained in this one in asynchronous mode.
+Searches for images contained in this one in asynchronous mode.
-TODO
+//Added in Actionaz 3.0.1.//
+=== Syntax ===
+<code javascript>
+myObject.findSubImagesAsync(otherImage, callback);
+</code>
+<code javascript>
+myObject.findSubImagesAsync(otherImage, callback, options);
+</code>
+=== Arguments ===
+  - otherImage - (Image) the Image to find
+  - callback(object) - (function) the function that will be called when the search ends
+    * position - ([[en:code:core:point|Point]]) the matching image center
+    * confidence - (integer) the confidence percentage
+  - options - (object) search options
+    * 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)
+    * 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 ===
+  * (Image) this Image
+=== Exceptions ===
+  * (FindSubImageError) an error occured while searching for a sub-image
+  * (ParameterTypeError) incorrect parameter type
+=== Example ===
+<code javascript>
+//Searches for objects on the screen
+var screenShot = Image.takeScreenshot();
+var imageToFind = new Image("object.png");
+screenShot.findSubImagesAsync(imageToFind, function(searchResult)
+{
+    if(searchResult)
+    {
+        Console.print("Matching images found\n");
+        for(var i = 0; i < searchResult.length; ++i)
+        {
+            Console.print("position: " + searchResult[i].position + ", confidence: " + searchResult[i].confidence + "\n");
+        }
+    }
+    else
+        Console.print("No matching images found.");
+});
+</code>
 ===== Enumerations =====
@@ Line 416: / 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