.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPPatterns

.. oe:function:: OEGetFPPatterns

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

      .. oe:api::

         OESystem::OEIterBase<OEFPPattern>* OEGetFPPatterns(const OEChem::OEMolBase& mol,
                                                            const OEFPTypeBase* fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPPatterns(mol: Union[OEGraphMol,OEMol,OEQMol],
                         fptype: OEFPTypeBase) -> Iterable[OEFPPattern]

   Returns an iterator over the patterns (:ref:`OEFPPattern <OEGraphSim_OEFPPattern>`)
   that are generated when a fingerprint is constructed.

   *mol*
      The :ref:`OEMolBase <OEChem_OEMolBase>` objects from which the fingerprint
      patterns are generated.

   *fptype*
      The type of the fingerprint that also stores the parameters that
      are used when the fingerprint is generated.

   .. note::

      The :oe:func:`OEGraphSim::OEGetFPPatterns` function is not
      available for the :oe:const:`OEGraphSim::OEFPType::Lingo`
      and  :oe:const:`OEGraphSim::OEFPType::MACCS166`
      fingerprint types.

   .. seealso::

      * :ref:`chapter_patterns` chapter
      * :oe:func:`OEGraphSim::OEGetFPCoverage` function
      * :oe:func:`OEGraphSim::OEGetFPOverlap` function
