summaryrefslogtreecommitdiff
path: root/debian/man/opencv_createsamples.1
blob: 39ab2de6c0accc8c60ae07b81a9e48ea73800843 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.TH "OPENCV_CREATESAMPLES" "1" "May 2010" "OpenCV" "User Commands"


.SH NAME
opencv_createsamples \- create training and testing samples


.SH SYNOPSIS
.B opencv_createsamples [options]


.SH DESCRIPTION
.PP
.B opencv_createsamples
creates positive samples from a single object image or a collection of
positive images.
.PP
The scheme of test samples creation is similar to training samples creation
since each test sample is a background image into which a randomly
distorted and randomly scaled instance of the object picture is pasted at a
random position.

.SH OPTIONS
.PP
.B opencv_createsamples
supports the following options:

.PP
.TP
.BI "\-info " collection_file_name
A database of positive source images. Use it together with
.B \-img
to create test samples instead.

.TP
.BI "\-img " image_file_name
A positive source image. Use it together with
.B \-info
to create test samples instead.

.TP
.BI "\-vec " vec_file_name
The output file name containing the generated positive samples for training.

.TP
.BI "\-bg " background_file_name
The background description file (the negative sample set). It contains a list
of images into which randomly distorted versions of the object are pasted for
positive sample generation.

.TP
.BI "\-num " number_of_samples
The number of positive samples to generate/train. The default is
.IR 1000 .

.TP
.BI "\-bgcolor " background_color
The background color (currently grayscale images are assumed); the background
color denotes the transparent color. The default is
.IR 0 .
.\" TODO: What does 0 mean? How are colors expressed with integers?

.TP
.B \-inv
Invert the colors.
.TP

.TP
.BI "\-maxidev " max_intensity_deviation
The desired maximum intensity deviation of foreground samples pixels. The
default is
.IR 40 .

.TP
.BI "\-maxxangle " max_x_rotation_angle
The maximum rotation angle in x-direction in radians. The default is
.IR 1.1 .

.TP
.BI "\-maxyangle " max_y_rotation_angle
The maximum rotation angle in y-direction in radians. The default is 
.IR 1.1 .

.TP
.BI "\-maxzangle " max_z_rotation_angle
The maximum rotation angle in z-direction in radians. The default is 
.IR 0.5 .

.TP
.BI "\-show [" scale_factor "]"
Show each created sample during the creation process. Optionally a scaling
factor can be defined. The default is
.IR 4.0 .
.IP
If <\fBESC\fR> is pressed, the creation process will continue without showing
the samples. This can be useful for debugging purposes.

.TP
.BI "\-h " sample_height
For the creation of training samples, it is the resulting sample height.
The default is
.IR 24 .
.IP
In case of creating test samples, it is the minimal height of placed object 
picture.

.TP
.BI "\-w " sample_width
For the creation of training samples, it is the resulting sample width.
The default is
.IR 24 .
.IP
In case of creating test samples, it is the minimal width of placed object
picture.

.PP
The same information is shown, if
.B opencv_createsamples
is called without any arguments/options.


.SH EXAMPLES
.PP
To create training samples from one image applying distortions and show the
results:
.IP
.B opencv_createsamples -img source.png -num 10 -bg negatives.dat -vec samples_out.vec -show
.PP
To create training samples of size 40x40 from some images without applying
distortions:
.IP
.B opencv_creasamples -info source.dat -vec samples_out.vec -w 40 -h 40


.SH SEE ALSO
.PP
.BR opencv_haartraing (1),
.BR opencv_performance (1)
.PP
More information and examples can be found in the OpenCV documentation.


.SH AUTHORS
.PP
This manual page was written by \fBDaniel Leidert\fR <\&daniel.leidert@wgdd.de\&>
and \fBNobuhiro Iwamatsu\fR <\&iwamatsu@debian.org\&>
for the Debian project (but may be used by others).