index.html
11.3 KB
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="docs/img/openbr.ico">
<title>OpenBR</title>
<link href="./css/bootstrap-custom.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="./css/highlight.css">
<link href="./css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#bs-sidebar">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href=".">OpenBR</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="active">
<a href=".">Home</a>
</li>
<li >
<a href="install/">Install</a>
</li>
<li >
<a href="tutorials/">Tutorials</a>
</li>
<li >
<a href="technical/">Technical Overviews</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">More <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="contribute/">Contribute</a>
</li>
<li >
<a href="papers/">Publications</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="docs/c_api/">C API</a>
</li>
<li >
<a href="docs/cpp_api/">C++ Plugin API</a>
</li>
<li >
<a href="docs/cl_api/">Command Line API</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Plugin Docs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="docs/plugins/classification/">Classification</a>
</li>
<li >
<a href="docs/plugins/cluster/">Cluster</a>
</li>
<li >
<a href="docs/plugins/core/">Core</a>
</li>
<li >
<a href="docs/plugins/distance/">Distance</a>
</li>
<li >
<a href="docs/plugins/format/">Format</a>
</li>
<li >
<a href="docs/plugins/gallery/">Gallery</a>
</li>
<li >
<a href="docs/plugins/gui/">GUI</a>
</li>
<li >
<a href="docs/plugins/imgproc/">Image Processing</a>
</li>
<li >
<a href="docs/plugins/io/">I/O</a>
</li>
<li >
<a href="docs/plugins/metadata/">Metadata</a>
</li>
<li >
<a href="docs/plugins/output/">Output</a>
</li>
<li >
<a href="docs/plugins/video/">Video</a>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li class="disabled">
<a rel="next" >
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="install/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li>
<a href="https://github.com/biometrics/openbr">
<i class="fa fa-github"></i>
GitHub
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#openbr">OpenBR</a></li>
<li><a href="#overview">Overview</a></li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#the-basics">The Basics</a></li>
<li><a href="#additional-materials">Additional Materials</a></li>
<li><a href="#help">Help</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="openbr">OpenBR <img alt="Overview" src="./img/openbr_48x48.png" /></h1>
<p>Open source, industry quality biometrics.</p>
<hr />
<h2 id="overview">Overview</h2>
<p>OpenBR \cite klontz2013open is a framework for investigating new modalities, improving existing algorithms, interfacing with commercial systems, measuring recognition performance, and deploying automated biometric systems.
The project is designed to facilitate rapid algorithm prototyping, and features a mature core framework, flexible plugin system, and support for open and closed source development.
Off-the-shelf algorithms are also available for specific modalities including <a href="tutorials/#face-recognition">face recognition</a>, <a href="tutorials/#age-estimation">age estimation</a>, and <a href="tutorials/#gender-estimation">gender estimation</a>. Please see the <a href="tutorials/">Tutorials</a> section for more information.</p>
<p>OpenBR originated within The MITRE Corporation from a need to streamline the process of prototyping new algorithms.
The project was later published as open source software under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2</a> license and is <em>free for academic and commercial use</em>.</p>
<p><img alt="Overview" src="./img/abstraction.svg" /></p>
<p><em>The two principal software artifacts are the shared library 'openbr' and command line application 'br'.</em></p>
<hr />
<h2 id="getting-started">Getting Started</h2>
<p>OpenBR is supported on multiple operating systems. Please select yours from the list below for installation instructions. Happy Hacking!</p>
<ul>
<li><a href="install/#linux">Linux</a></li>
<li><a href="install/#osx">Mac OSX</a></li>
<li><a href="install/#windows">Windows</a></li>
<li><a href="install/#raspian">Raspian</a></li>
</ul>
<hr />
<h2 id="the-basics">The Basics</h2>
<p>We have created a few tutorials to help teach you the basic principles of the OpenBR system. If this is your first time using OpenBR you should look at these before moving on to the more technical descriptions below.</p>
<ul>
<li><a href="tutorials/#quick-start">Quick Start</a></li>
<li><a href="tutorials/#training-in-openbr">Training in OpenBR</a></li>
<li><a href="tutorials/#face-recognition">Face Recognition</a></li>
<li><a href="tutorials/#age-estimation">Age Estimation</a></li>
<li><a href="tutorials/#gender-estimation">Gender Estimation</a></li>
</ul>
<hr />
<h2 id="additional-materials">Additional Materials</h2>
<p>OpenBR has several parts. Below are several more technical descriptions of important parts of the system. Enjoy!</p>
<ul>
<li><a href="technical/#algorithms-in-openbr">Algorithms in OpenBR</a></li>
<li><a href="docs/c_api/">The C API</a></li>
<li><a href="docs/cl_api/">The Command Line Interface</a></li>
<li><a href="docs/cpp_api/">The C++ Plugin API</a></li>
<li><a href="technical/#the-evaluation-harness">The Evaluation Harness</a></li>
</ul>
<hr />
<h2 id="help">Help</h2>
<p>Still have questions? Please reach out to us on our <a href="https://groups.google.com/forum/?fromgroups#!forum/openbr-dev">developer mailing list</a> or our <a href="http://webchat.freenode.net/?channels=openbr">IRC channel</a></p></div>
</div>
<!-- Search modal. Not yet supported. -->
<div class="modal fade" id="searchModal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h4 class="modal-title" id="searchModalLabel">Documentation search</h4>
</div>
<div class="modal-body">
...
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div>
</div>
</div>
<script src="./js/jquery-1.10.2.min.js"></script>
<script src="./js/bootstrap-3.0.3.min.js"></script>
<script src="./js/highlight.pack.js"></script>
<script src="./js/base.js"></script>
</body>
</html>