mirror of
https://github.com/bspeice/libcvautomation
synced 2025-07-01 22:07:38 -04:00
Release version 1.3
This commit is contained in:
Bradlee Speice
80
docs/man/man1/cva-input.1
Normal file
80
docs/man/man1/cva-input.1
Normal file
@ -0,0 +1,80 @@
|
||||
.TH "cva-input" 1 "23 Jul 2012" "Version 1.3" "libcvautomation" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
cva-input \- \fBAuthor:\fP
|
||||
.RS 4
|
||||
Bradlee Speice <bspeice@uncc.edu>
|
||||
.RE
|
||||
.PP
|
||||
.SH "Usage:"
|
||||
.PP
|
||||
This program works kind of like a mini-language. All options are parsed left-to-right, and executed right there. Thus, specifying '--display' at different places in the options will cause this program to use the most recent given display. The return code is 1 if there are no commands given, or if all commands fail. It is 0 otherwise.
|
||||
.SH "Example Usage:"
|
||||
.PP
|
||||
Click the mouse:
|
||||
.PP
|
||||
cva-input -s 'click 1'
|
||||
.PP
|
||||
Press key 'a':
|
||||
.PP
|
||||
cva-input -s 'keyclick a'
|
||||
.SH "Full Options:"
|
||||
.PP
|
||||
-h, --help: Display this usage message.
|
||||
.PP
|
||||
-u, --usage: Display this usage message.
|
||||
.PP
|
||||
-d, --display: Specify the X display to use.
|
||||
.PP
|
||||
-m, --search-method: Specify a method to search by. See \fCcva-match --help\fP for more information on this.
|
||||
.PP
|
||||
-t, --tolerance: Specify how strict the match is.
|
||||
.PP
|
||||
-b, --button: Specify the mouse button to press (default 1).
|
||||
.PP
|
||||
-c, --center: Instead of matching the top-left corner of an image, match the center of the image.
|
||||
.PP
|
||||
-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)
|
||||
.PP
|
||||
-s, --string: Command string - see below.
|
||||
.PP
|
||||
-i, --timeout: Specify the timeout to use when using the 'waitfor' command
|
||||
.SH "Full Command List:"
|
||||
.PP
|
||||
\fCmouseclick:\fP Click the mouse in-place.
|
||||
.PP
|
||||
\fCimouseclick:\fP Click the mouse at an image's top-left corner.
|
||||
.PP
|
||||
\fCicmouseclick:\fP Click the mouse at an image's center.
|
||||
.PP
|
||||
\fCmousexy:\fP Move the mouse to the given coordinate.
|
||||
.PP
|
||||
\fCmouserxy:\fP Move the mouse by the given x and y values (relative motion).
|
||||
.PP
|
||||
\fCmouseimage:\fP Move the mouse to an image's top-left corner.
|
||||
.PP
|
||||
\fCcmouseimage:\fP Move the mouse to an image's center.
|
||||
.PP
|
||||
\fCmousedown:\fP Push and leave down a mouse button.
|
||||
.PP
|
||||
\fCmouseup:\fP Release a mouse button.
|
||||
.PP
|
||||
\fCmousejiggle:\fP Jiggle the mouse (helps to activate some widgets).
|
||||
.PP
|
||||
\fCmousescrollu:\fP Scroll the mouse wheel up
|
||||
.PP
|
||||
\fCmousescrolld:\fP Scroll the mouse wheel down
|
||||
.PP
|
||||
\fCkeyclick:\fP Click a keyboard button.
|
||||
.PP
|
||||
\fCkeydown:\fP Push and leave down a keyboard button.
|
||||
.PP
|
||||
\fCkeyup:\fP Release a keyboard button.
|
||||
.PP
|
||||
\fCkeystring:\fP Input a string of keys to X11.
|
||||
.PP
|
||||
\fCwaitfor:\fP Wait for an image to be displayed
|
||||
.SH "Contact Information:"
|
||||
.PP
|
||||
Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at <bspeice@uncc.edu>
|
||||
60
docs/man/man1/cva-match.1
Normal file
60
docs/man/man1/cva-match.1
Normal file
@ -0,0 +1,60 @@
|
||||
.TH "cva-match" 1 "23 Jul 2012" "Version 1.3" "libcvautomation" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
cva-match \- \fBAuthor:\fP
|
||||
.RS 4
|
||||
Bradlee Speice <bspeice@uncc.edu>
|
||||
.RE
|
||||
.PP
|
||||
.SH "Usage:"
|
||||
.PP
|
||||
This program uses OpenCV in order to recognize an image within an image. The return code is 0 for at least one successful match, and 1 otherwise.
|
||||
.SH "Example Usage:"
|
||||
.PP
|
||||
Match two images against the root X11 window:
|
||||
.PP
|
||||
cva-match --x-root -s '<image_name>' -s '<image_name_2>'
|
||||
.PP
|
||||
Match a root and sub image with a custom tolerance and search method
|
||||
.PP
|
||||
cva-match -r '<root_image>' -s '<image_name>' -o 75 -m 1
|
||||
.SH "Full Options:"
|
||||
.PP
|
||||
-h, --help: Display this usage message.
|
||||
.PP
|
||||
-u, --usage: Display this usage message.
|
||||
.PP
|
||||
-r, --root-image: Location of the root image to compare against.
|
||||
.PP
|
||||
-s, --sub-image: Location of the sub-image to find in root.
|
||||
.PP
|
||||
-p, --separator: Separator of the X and Y coordinates.
|
||||
.PP
|
||||
-t, --tolerance: Set how strict the match is - 100 is recommended lowest value.
|
||||
.PP
|
||||
\fBNote:\fP
|
||||
.RS 4
|
||||
When using CCORR or CCOEFF tolerance works in opposite direction, so -50 is recommended highest value.
|
||||
.RE
|
||||
.PP
|
||||
-m, --search-method: Set which method is used to search for sub-images.
|
||||
.PP
|
||||
\fBNote:\fP
|
||||
.RS 4
|
||||
Search Methods: CV_TM_SQDIFF = 0, CV_TM_SQDIFF_NORMED = 1, CV_TM_CCORR = 2, CV_TM_CCORR_NORMED = 3, CV_TM_CCOEFF = 4, CV_TM_COEFF_NORMED = 5
|
||||
.RE
|
||||
.PP
|
||||
-x, --x-root[=DISPLAY]: Set the root image to come from X11
|
||||
.PP
|
||||
\fBNote:\fP
|
||||
.RS 4
|
||||
The DISPLAY variable is optional, not specifying it will cause X to use the default display (not specifically :0.0)
|
||||
.RE
|
||||
.PP
|
||||
-c, --center: The output points should be centered on the sub-image, rather than the top-left corner.
|
||||
.PP
|
||||
-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)
|
||||
.SH "Contact Information:"
|
||||
.PP
|
||||
Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at <bspeice@uncc.edu>
|
||||
Reference in New Issue
Block a user