.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeVSFP

..  _OEGraphSim_OEMakeVSFP:

.. oe:function:: OEMakeVSFP

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

      .. oe:api::

         bool OEMakeVSFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                         const unsigned fptype, const unsigned vsversion = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeVSFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                    fptype: int, vsVersion: int = 0) -> bool

   This function generates a virtual screening fingerprint from the given molecule for the requested fingerprint type.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.
      If the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree`, or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other fingerprint types that have no virtual screening equivalent simply return
      the requested non-VS fingerprint.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.2 toolkits), and ``0u`` or  ``2u`` (2025.2 toolkits onwards).

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEMakeFP`
         * :ref:`OEGetVSFPType <OEGraphSim_OEGetVSFPType>`


