Crop Image

Crop an existing image.

Arguments

Argument Type Default value Description
imageImage to crop
regionRegion to crop image to
filenameNoneSave cropped image to filename
param image:Image to crop
param region:Region to crop image to
param filename:Save cropped image to filename

Find Template In Image

DEPRECATED Use keyword Find from library RPA.Recognition instead Attempt to find the template from the given image.

Arguments

Argument Type Default value Description
imagePath to image or Image instance, used to search from
templatePath to image or Image instance, used to search with
regionNoneArea to search from. Can speed up search significantly.
limitNoneLimit returned results to maximum of limit.
toleranceNoneTolerance for matching, value between 0.1 and 1.0

DEPRECATED Use keyword Find from library RPA.Recognition instead Attempt to find the template from the given image.

param image:Path to image or Image instance, used to search from
param template:Path to image or Image instance, used to search with
param limit:Limit returned results to maximum of limit.
param region:Area to search from. Can speed up search significantly.
param tolerance:
 Tolerance for matching, value between 0.1 and 1.0
return:List of matching regions
raises ImageNotFoundError:
 No match was found

Find Template On Screen

DEPRECATED!! use RPA.Desktop.Find Element instead Attempt to find the template image from the current desktop. For argument descriptions, see find_template_in_image()

Arguments

Argument Type Default value Description
template
**kwargs

DEPRECATED!! use RPA.Desktop.Find Element instead Attempt to find the template image from the current desktop. For argument descriptions, see find_template_in_image()

Get Pixel Color In Image

Get the RGB value of a pixel in the image.

Arguments

Argument Type Default value Description
imageimage to get pixel from
pointcoordinates for pixel or Point object
param image:image to get pixel from
param point:coordinates for pixel or Point object

Get Pixel Color On Screen

Get the RGB value of a pixel currently on screen.

Arguments

Argument Type Default value Description
pointcoordinates for pixel or Point object
param point:coordinates for pixel or Point object

Show Region In Image

Draw a rectangle onto the image around the given region.

Arguments

Argument Type Default value Description
imageimage to draw onto
regioncoordinates for region or Region object
colorredcolor of rectangle
width5line width of rectangle
param image:image to draw onto
param region:coordinates for region or Region object
param color:color of rectangle
param width:line width of rectangle

Show Region On Screen

Draw a rectangle around the given region on the current desktop.

Arguments

Argument Type Default value Description
regioncoordinates for region or Region object
colorredcolor of rectangle
width5line width of rectangle
param region:coordinates for region or Region object
param color:color of rectangle
param width:line width of rectangle

Take Screenshot

DEPRECATED Use keyword RPA.Desktop.Take Screenshot instead Take a screenshot of the current desktop.

Arguments

Argument Type Default value Description
filenameNoneSave screenshot to filename
regionNoneRegion to crop screenshot to

DEPRECATED Use keyword RPA.Desktop.Take Screenshot instead Take a screenshot of the current desktop.

param filename:Save screenshot to filename
param region:Region to crop screenshot to

Wait Template On Screen

DEPRECATED!! use RPA.Desktop.Wait For Element instead Wait for template image to appear on current desktop. For further argument descriptions, see find_template_in_image()

Arguments

Argument Type Default value Description
template
timeout5Time to wait for template (in seconds)
**kwargs

DEPRECATED!! use RPA.Desktop.Wait For Element instead Wait for template image to appear on current desktop. For further argument descriptions, see find_template_in_image()

param timeout:Time to wait for template (in seconds)