RPA.Images

Crop an existing image.

Arguments

Argument	Type	Default value	Description
image			Image to crop
region			Region to crop image to
filename		None	Save cropped image to filename

param image:	Image to crop
param region:	Region to crop image to
param filename:	Save cropped image to filename

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

Arguments

Argument	Type	Default value	Description
image			Path to image or Image instance, used to search from
template			Path to image or Image instance, used to search with
region		None	Area to search from. Can speed up search significantly.
limit		None	Limit returned results to maximum of limit.
tolerance		None	Tolerance 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

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 the RGB value of a pixel in the image.

Arguments

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

param image:	image to get pixel from
param point:	coordinates for pixel or Point object

Get the RGB value of a pixel currently on screen.

Arguments

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

param point:	coordinates for pixel or Point object

Draw a rectangle onto the image around the given region.

Arguments

Argument	Type	Default value	Description
image			image to draw onto
region			coordinates for region or Region object
color		red	color of rectangle
width		5	line 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

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

Arguments

Argument	Type	Default value	Description
region			coordinates for region or Region object
color		red	color of rectangle
width		5	line width of rectangle

param region:	coordinates for region or Region object
param color:	color of rectangle
param width:	line width of rectangle

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

Arguments

Argument	Type	Default value	Description
filename		None	Save screenshot to filename
region		None	Region 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

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
timeout		5	Time 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)