index.html 9.23 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>C API - 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 ">
            <a class="" href="../..">Home</a>

            </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 current">
            <a class="current" href="./">C API</a>

                <ul>


            <li class="toctree-l2 ">
            <a class="" href="typedefs/">Typedefs</a>

            </li>


            <li class="toctree-l2 ">
            <a class="" href="functions/">Functions</a>

            </li>


                </ul>

            </li>


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

            </li>


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

            </li>


            <span>Plugin Docs</span>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


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

            </li>


            <li class="toctree-l1 ">
            <a class="" href="../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>API Docs &raquo;</li>


    <li>C API</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="c-api">C API</h1>
<p>The C API is a high-level API for running algorithms and evaluating results.</p>
<p>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.
In other words, arguments to many functions are file paths that specify either a source of input or a desired output.
File extensions are relied upon to determine <em>how</em> files should be interpreted in the context of the function being called.
The <a href="../cpp_api/">C++ Plugin API</a> should be used if more fine-grained control is required.</p>
<h2 id="import-api-considerations">Import API considerations</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Consideration</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="table-anchor" id="memory"></a>Memory</td>
<td>Memory for <tt>const char*</tt> return values is managed internally and guaranteed until the next call to the function</td>
</tr>
<tr>
<td><a class="table-anchor" id="input-string-buffers"></a>Input String Buffers</td>
<td>Users should input a char * buffer and the size of that buffer. String data will be copied into the buffer, if the buffer is too small, only part of the string will be copied. Returns the buffer size required to contain the complete string.</td>
</tr>
</tbody>
</table>
<h2 id="using-the-api">Using the API</h2>
<p>To use the API in your project use-</p>
<pre><code>#include &lt;openbr/openbr.h&gt;
</code></pre>
<p><a href="http://www.cmake.org/">CMake</a> developers may wish to the cmake configuration file found at</p>
<pre><code>share/openbr/cmake/OpenBRConfig.cmake
</code></pre>
<p>Please see the <a href="../../tutorials/">tutorials</a> section for examples.</p>
<!-- Links -->

<!-- Contributors -->

            </div>
          </div>
          <footer>

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

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


        <a href="../../papers/" class="btn btn-neutral" title="Publications"><span class="icon icon-circle-arrow-left"></span> Previous</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><a href="../../papers/" style="color: #fcfcfc;">&laquo; Previous</a></span>


        <span style="margin-left: 15px"><a href="typedefs/" 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.442459
-->
</body>
</html>