Image

This object represents an image.

Constructor function.

var myObject = new Image();

var myObject = new Image(otherImage);

var myObject = new Image(filename);

1. otherImage - (Image) other Image to copy
2. filename - (string) a valid image filename

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

Create a empty Image.

var myObject = new Image();

Create a Image representing a copy of otherImage.

var myObject = new Image(otherImage);

Take a screenshot of the whole screen or only of window and store the result in a new Image.

var myObject = Image.takeScreenshot();

var myObject = Image.takeScreenshot(window);

1. window - (Window) the window to screenshot

• (InvalidWindowError) invalid window

Take a screenshot of one screen and store the result in a new Image. [Added in Actionaz 3.7.0.]

var myObject = Image.takeScreenshotUsingScreenIndex(0);

1. screenIndex - (integer) the index of the screen to screenshot

• (InvalidScreenIndexError) invalid screen index

Returns a copy of this Image.

myObject.clone();

• (Image) a copy of this Image

var copyOfMyObject = myObject.clone();

Returns true if this Image and another are referencing the same image.

myObject.equals(other);

1. other - (Image) another Image

• (bool) true if other is referencing the same image

if(myFirstObject.equals(mySecondObject))
	//Do something

Returns a string representing this Image.

myObject.toString();

• (string) a string representing this Image

Console.print(myObject.toString());

This method is automatically called when trying to convert a Image to a string.

Sets the data of this Image.

myObject.setData(data);

1. data - (RawData) RawData of the image

• (Image) this Image

• (ImageDataError) invalid image data

Supported image formats are BMP, GIF, JPG, JPEG, PNG, PBM, PGM, PPM, TIFF, XBM and XPM.

Returns the data of this Image as RawData in the BMP format.

myObject.data();

• (RawData) this Image as RawData

• (ImageDataError) unable to get the image data

Loads the Image from a file.

myObject.loadFromFile(filename);

1. filename - (string) filename to load

• (Image) this Image

• (LoadImageError) unable to load the image

Supported image formats are BMP, GIF, JPG, JPEG, PNG, PBM, PGM, PPM, TIFF, XBM and XPM.

Saves the Image to a file.

myObject.saveToFile(filename);

1. filename - (string) filename to save to

• (Image) this Image

• (SaveImageError) unable to save the image

Supported image formats are BMP, JPG, JPEG, PNG, PPM, TIFF, XBM and XPM.

Applies a filter on this Image.

myObject.applyFilter(filter);

myObject.applyFilter(filter, options);

1. filter - (Filter) the filter to use
2. options - (object) filter options
   • filterChannels - (string) the color channel(s) to perform the filtering on. A string consisting of zero or one entity of each of the characters r,g,b,a
   • filterBorderPolicy - (string) used with the convolution filter. Values are "mirror", "extend" or "wrap"
   • convolutionDivisor - (integer) the convolution divisor
   • convolutionBias - (integer) the convolution bias
   • radius - (number) the radius
   • force - (number) the force (use it, Luke!)
   • center - (object) the center
     • x - (integer) the x coordinate
     • y - (integer) the y coordinate

• (Image) this Image

• (ApplyFilterError) unable to apply the filter

Returns a pixel from this Image.

myObject.pixel(x, y);

1. x - (integer) x coordinate of the pixel to return
2. y - (integer) y coordinate of the pixel to return

• (Color) the pixel

Sets a pixel from this Image.

myObject.pixel(x, y, color);

myObject.pixel(x, y, colorString);

myObject.pixel(x, y, red, green, blue);

1. x - (integer) x coordinate of the pixel to set
2. y - (integer) y coordinate of the pixel to set
3. color - (Color) color of the pixel to set
4. red - (integer) red value of the color to set
5. green - (integer) green value of the color to set
6. blue - (integer) blue value of the color to set

• (Image) this Image

Mirror this Image.

myObject.mirror(mirrorOrientation);

1. mirrorOrientation - (MirrorOrientation) mirror orientation

• (Image) this Image

Resizes this Image.

myObject.setSize(size);

myObject.setSize(width, height);

1. size - (Size) the new Image size
2. width - (integer) the new width of this Image
3. height - (integer) the new height of this Image

• (Image) this Image

Returns the size of this Image.

myObject.size();

• (Size) the size of this Image

Returns the width of this Image.

myObject.width();

• (integer) the width of this Image

Returns the height of this Image.

myObject.height();

• (integer) the height of this Image

Returns a copy of this Image or only a part of it.

myObject.copy();

myObject.copy(rect);

1. rect - (Rect) the section of this Image to copy

• (Image) a new copy of this Image

Searches for another image contained in this one.

Added in Actionaz 3.0.1.

myObject.findSubImage(otherImage);

myObject.findSubImage(otherImage, options);

1. otherImage - (Image) the Image to find
2. 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)
   • method - (Method) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

• (object) the matching point, or null if no matching point can be found
  • position - (Point) the matching image center
  • confidence - (integer) the confidence percentage

• (FindSubImageError) an error occured while searching for a sub-image
• (ParameterTypeError) incorrect parameter type

//Searches for an object on the screen
var screenShot = Image.takeScreenshot();
var imageToFind = new Image("object.png");
 
var searchResult = screenShot.findSubImage(imageToFind);
if(searchResult)
    Console.print("Matching image found, position: " + searchResult.position + ", confidence: " + searchResult.confidence);
else
    Console.print("No matching image found.");

Searches for images contained in this one.

Added in Actionaz 3.0.1.

myObject.findSubImages(otherImage);

myObject.findSubImages(otherImage, options);

1. otherImage - (Image) the Image to find
2. 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) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

• (array of objects) the matching points, or null if no matching point can be found
  • position - (Point) the matching image center
  • confidence - (integer) the confidence percentage

• (FindSubImageError) an error occured while searching for a sub-image
• (ParameterTypeError) incorrect parameter type

//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.");

Searches for another image contained in this one in asynchronous mode.

Added in Actionaz 3.0.1.

myObject.findSubImageAsync(otherImage, callback);

myObject.findSubImageAsync(otherImage, callback, options);

1. otherImage - (Image) the Image to find
2. callback(object) - (function) the function that will be called when the search ends
   • position - (Point) the matching image center
   • confidence - (integer) the confidence percentage
3. 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) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

• (Image) this Image

• (FindSubImageError) an error occured while searching for a sub-image
• (ParameterTypeError) incorrect parameter type

//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.");
});

Searches for images contained in this one in asynchronous mode.

Added in Actionaz 3.0.1.

myObject.findSubImagesAsync(otherImage, callback);

myObject.findSubImagesAsync(otherImage, callback, options);

1. otherImage - (Image) the Image to find
2. callback(object) - (function) the function that will be called when the search ends
   • position - (Point) the matching image center
   • confidence - (integer) the confidence percentage
3. 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) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

• (Image) this Image

• (FindSubImageError) an error occured while searching for a sub-image
• (ParameterTypeError) incorrect parameter type

//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.");
});

Image filters.

1. ConvolutionFilter: the convolution filter
2. GaussianBlur: a gaussian blur
3. Defocus: blurs the image
4. Highlight: highlight the image
5. Sharpen: sharpens the image
6. SharpenMore: sharpens the image
7. SharpenEvenMore: sharpens the image
8. EdgeDetect: edge detection filter
9. BigEdge: edge detection filter (thicker edges)
10. Emboss: embosses the image (no color preservation)
11. EmbossColor: embosses the image (color preservation)
12. Negative: negates a color channel
13. RemoveChannel: remove a color channel
14. Punch: distorts the image

Mirror orientation.

1. Vertical: a vertical mirror
2. Horizontal: an horizontal mirror

Search method. [Added in Actionaz 3.7.0.]

1. CorrelationCoefficient: correlation coefficient, best for most use cases
2. CrossCorrelation: cross correlation
3. SquaredDifference: squared difference