index.html 10.2 KB

Edit Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>OpenBR</title>


  <link rel="shortcut icon" href="docs/img/openbr.ico">


</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">


    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="." class="icon icon-home"> OpenBR</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
      <ul class="current">


            <li class="toctree-l0 current">
            <a class="current" href=".">Home</a>

                <ul>


                            <li class="toctree-l1"><a href="#openbr">OpenBR</a></li>


                </ul>

            </li>


            <li class="toctree-l0 ">
            <a class="" href="install/">Install</a>

            </li>


            <li class="toctree-l0 ">
            <a class="" href="tutorials/">Tutorials</a>

            </li>


            <li class="toctree-l0 ">
            <a class="" href="technical/">Technical Overviews</a>

            </li>


            <li class="toctree-l0 ">
            <a class="" href="contribute/">Contribute</a>

            </li>


            <li class="toctree-l0 ">
            <a class="" href="papers/">Publications</a>

            </li>


            <span>API Docs</span>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/c_api/">C API</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/cpp_api/">C++ Plugin API</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/cl_api/">Command Line API</a>

            </li>


            <span>Plugin Docs</span>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/classification/">Classification</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/cluster/">Cluster</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/core/">Core</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/distance/">Distance</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/format/">Format</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/gallery/">Gallery</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/gui/">GUI</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/imgproc/">Image Processing</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/io/">I/O</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/metadata/">Metadata</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/output/">Output</a>

            </li>


            <li class="toctree-l1 ">
            <a class="" href="api_docs/plugins/video/">Video</a>

            </li>


</ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href=".">OpenBR</a>
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href=".">Docs</a> &raquo;</li>


    <li>Home</li>
    <li class="wy-breadcrumbs-aside">


          <a href="https://github.com/biometrics/openbr" class="icon icon-github"> Edit on GitHub</a>


    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">

                <h1 id="openbr">OpenBR <img alt="Overview" src="./img/openbr_48x48.png" /></h1>
<p id=tagline>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>
<figure id="abstraction">
  <img src="img/abstraction.svg">
  <figcaption>The two principal software artifacts are the shared library 'openbr' and command line application 'br'.</figcaption>
</figure>

<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-algorithms">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="api_docs/c_api/">The C API</a></li>
<li><a href="api_docs/cl_api/">The Command Line Interface</a></li>
<li><a href="api_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>
<!-- Links -->

<!-- Contributors -->

            </div>
          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="install/" class="btn btn-neutral float-right" title="Install"/>Next <span class="icon icon-circle-arrow-right"></span></a>


    </div>


  <hr/>

  <div role="contentinfo">
    <p>
    <!-- Copyright etc -->
    </p>
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

        </div>
      </div>

    </section>

  </div>

<div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">

          <a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>


        <span style="margin-left: 15px"><a href="install/" style="color: #fcfcfc">Next &raquo;</a></span>

    </span>
</div>


<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

<link rel="stylesheet" href="./css/theme.css" type="text/css" />
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="./css/highlight.css">

<script src="./js/jquery-2.1.1.min.js"></script>
<script src="./js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="./js/highlight.pack.js"></script>
<script src="./js/theme.js"></script>

<!--
MkDocs version      : 0.12.1
Docs Build Date UTC : 2015-04-24 17:55:27.319307
-->
</body>
</html>