diff --git a/app/br/br.cpp b/app/br/br.cpp index 58b49dc..50204a8 100644 --- a/app/br/br.cpp +++ b/app/br/br.cpp @@ -24,9 +24,9 @@ /*! * \defgroup cli Command Line Interface - * \brief Command line application for running algorithms and evaluating results. + * \brief Command line wrapper of the \ref c_sdk. * - * The easiest and fastest way to leverage the project, we use it all the time! + * The easiest and fastest way to run algorithms and evaluating results, we use it all the time! * Commands are designed to mirror the \ref c_sdk and are evaluated in the order they are entered. * To get started, try running: * \code diff --git a/openbr/openbr.h b/openbr/openbr.h index 0f9bb0f..d4add7d 100644 --- a/openbr/openbr.h +++ b/openbr/openbr.h @@ -25,7 +25,7 @@ extern "C" { /*! * \defgroup c_sdk C SDK - * \brief High-level API for running algorithms and evaluating results with wrappers available for other programming languages. + * \brief High-level API for running algorithms and evaluating results. * * In order to provide a high-level interface that is usable from the command line and callable from other programming languages, * the API is designed to operate at the "file system" level. diff --git a/openbr/openbr_export.cpp b/openbr/openbr_export.cpp index ed12151..0696346 100644 --- a/openbr/openbr_export.cpp +++ b/openbr/openbr_export.cpp @@ -17,22 +17,27 @@ /*! * \mainpage * \section overview Overview - * OpenBR \cite openbr is a toolkit for biometric recognition and evaluation. - * Supported use cases include training new recognition algorithms, interfacing with commercial systems, and measuring algorithm performance. - * Free algorithms are also available for specific modalities including \ref cpp_face_recognition, \ref cpp_age_estimation, and \ref cpp_gender_estimation. + * OpenBR \cite openbr 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 \ref cpp_face_recognition, \ref cpp_age_estimation, and \ref cpp_gender_estimation. * - * There are three modules users may interact with: - * - \ref cli - \copybrief cli - * - \ref c_sdk - \copybrief c_sdk - * - \ref cpp_plugin_sdk - \copybrief cpp_plugin_sdk + * 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 Apache 2 license and is free for academic and commercial use. + * + * \image html "share/openbr/abstraction.svg" "The two principal software artifacts are the shared library 'openbr' and command line application 'br'." * * \section get_started Get Started * - \ref installation - \copybrief installation + * + * \section learn_more Learn More + * - \ref cli - \copybrief cli + * - \ref c_sdk - \copybrief c_sdk + * - \ref cpp_plugin_sdk - \copybrief cpp_plugin_sdk */ /*! * \page installation Installation - * \brief A hacker's guide to building, editing, and running the project. + * \brief A hacker's guide to building, editing, and running OpenBR. * * \section installation_from_source From Source * Installation from source is the recommended method for getting OpenBR on your machine. diff --git a/openbr/openbr_plugin.h b/openbr/openbr_plugin.h index 53b2026..b88f168 100644 --- a/openbr/openbr_plugin.h +++ b/openbr/openbr_plugin.h @@ -44,7 +44,7 @@ /*! * \defgroup cpp_plugin_sdk C++ Plugin SDK - * \brief Plugin API for developing new algorithms. + * \brief Plugin API for extending OpenBR functionality. * * \code * #include diff --git a/share/openbr/Doxyfile.in b/share/openbr/Doxyfile.in index 34c352c..22c56b8 100644 --- a/share/openbr/Doxyfile.in +++ b/share/openbr/Doxyfile.in @@ -755,7 +755,7 @@ EXAMPLE_RECURSIVE = YES # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = ${CMAKE_SOURCE_DIR} # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program diff --git a/share/openbr/abstraction.svg b/share/openbr/abstraction.svg index 36cecfe..49dae6c 100644 --- a/share/openbr/abstraction.svg +++ b/share/openbr/abstraction.svg @@ -11,7 +11,7 @@ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" width="512" - height="416" + height="400" id="svg2" version="1.1" inkscape:version="0.48.2 r9819" @@ -40,12 +40,12 @@ inkscape:pageshadow="2" inkscape:zoom="1.1446731" inkscape:cx="160.23068" - inkscape:cy="221.30937" + inkscape:cy="162.70186" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" - inkscape:window-width="1386" - inkscape:window-height="856" + inkscape:window-width="1280" + inkscape:window-height="756" inkscape:window-x="54" inkscape:window-y="0" inkscape:window-maximized="0" /> @@ -65,30 +65,30 @@ inkscape:label="Layer 1" inkscape:groupmode="layer" id="layer1" - transform="translate(0,-636.36218)"> + transform="translate(0,-652.36218)"> + y="667.36218" /> + y="667.36218" /> @@ -96,24 +96,24 @@ xml:space="preserve" style="font-size:40px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans Italic" x="70.554688" - y="699.79578" + y="713.79578" id="text2995" sodipodi:linespacing="125%">br + y="713.79578">br OpenBR + y="784.04187">OpenBR Qt &Qt &OpenCV + y="811.36218" /> + y="811.36212" /> + y="883.36218" /> + y="811.36218" /> LBP + y="850.36218">LBP HOG + y="922.1073">HOG SVM + y="850.1073">SVM + y="883.36218" /> ... + y="922.36218">... CommercialWrapper CommercialApplication + y="959.36218" /> + y="1008.3622" /> Source Code + y="985.02234">Source Code Shared Library + y="1031.37">Shared Library Application + y="984.37">Application PluginPlugin + y="1007.3622" /> + y="959.36218" /> + style="fill:#ffffbf;fill-opacity:1;stroke:#000000;stroke-width:1.99999988;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3.99999997, 7.99999995;stroke-dashoffset:0" /> CommercialLibrary + style="fill:#fc8d59;fill-opacity:1;stroke:#000000;stroke-width:1.99999988;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" /> Open SourceApplication CoreFramework www.openbiometrics.org - + style="fill:#99d59e;fill-opacity:1;stroke:#000000;stroke-width:2;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3.99999988, 7.99999978;stroke-dashoffset:0" /> PCA LDA