.. include:: ../common/cookbook/cookbook-hyperlinks

.. _section_examples_summary_makefastfp:

Generating fingerprint file for fast fingerprint search
=========================================================

A program that generates a binary fingerprint file for fast
fingerprint search.

.. figure:: images/makefastfp.*
   :align:  center
   :width:  300pt

   **Schematic representation of fast fingerprint generation process**


.. seealso::

   * Example code in the :ref:`section_examples_summary_searchfastfp` section
   * `Rapid Similarity Searching of Large Molecule File`_ OpenEye Python Cookbook example

Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      prompt> makefastfp --help

.. oe:language:: python

   .. code-block:: console

      prompt> python makefastfp.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java MakeFastFP --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> MakeFastFP --help


will generate the following output:

.. code-block:: console

   Simple parameter list

    fingerprint options
      -atomtype : Fingerprint atom type
      -bondtype : Fingerprint bond type
      -fptype : Fingerprint type
      -maxdistance : Maximum number of bonds/radius in path/circular/tree
      -mindistance : Minimum number of bonds/radius in path/circular/tree
      -numbits : Size of bitvector

    input/output options
      -fpdbfname : Output fingerprint database filename
      -in : Input molecule filename


Code
--------------------------------------------------------------------------------

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastfp.py <../../../../wrappers/python/examples/graphsim/makefastfp.py>`

   ..   literalinclude:: ../../../../wrappers/python/examples/graphsim/makefastfp.py

   .. only:: oepdf

      .. oe:source:: makefastfp.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`makefastfp.cpp <../../../../sublibs/tklibs/graphsim/examples/makefastfp.cpp>`
         and
         :download:`makefastfp.txt <../../../../sublibs/tklibs/graphsim/examples/makefastfp.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: makefastfp.cpp
         :language: c++

      with interface file

      .. oe:source:: makefastfp.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFastFP.java <../../../../wrappers/java/examples/openeye/examples/oegraphsim/MakeFastFP.java>`
         and
         :download:`MakeFastFP.txt <../../../../wrappers/java/examples/openeye/examples/oegraphsim/MakeFastFP.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: MakeFastFP.java
         :language: java

      with interface file

      .. oe:source:: MakeFastFP.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MakeFastFP.cs <../../../../wrappers/csharp/Csharp-Examples/OEGraphSim/MakeFastFP.cs>`

   .. only:: oepdf

      .. oe:source:: MakeFastFP.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEGraphSim::OEConfigureFingerPrint` and
     :oe:func:`OEGraphSim::OESetupFingerPrint` functions
   * :oe:func:`OEChem::OEGetMolDatabaseIdxFileName` and
     :oe:func:`OEChem::OECreateMolDatabaseIdx` functions in **OEChem TK** manual
   * :ref:`OEMolDatabase <OEChem_OEMolDatabase>` class in **OEChem TK** manual
   * :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` class
   * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function
