.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEConfigureFingerPrint

.. oe:function:: OEConfigureFingerPrint

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEConfigureFingerPrint(OESystem::OEInterface& itf,
                                     const OEFPTypeBase* deffptype)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureFingerPrint(itf: OEInterface, deffptype: OEFPTypeBase) -> bool

   Configures the given interface to add the following parameters for user-defined
   fingerprint type:

   ::

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


   *itf*
      The interface being configured.

   *deffptype*
      The default fingerprint type.


   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class
      * :oe:func:`OEGraphSim::OESetupFingerPrint` function
      * Example code in :ref:`section_examples_summary_makefastfp` section
      * Example code in :ref:`section_examples_summary_searchfp` section
