.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OEMatchedPairGetTransforms MatchedPairGetTransforms GetTransforms MatchedPairs

.. oe:function:: OEMatchedPairGetTransforms

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

      .. oe:api::

         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             int context,
                                                                                             unsigned int extractMode = OEMatchedPairTransformExtractMode::Default)
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEChem::OEMolBase& probemol,
                                                                                             int context,
                                                                                             unsigned int extractMode = OEMatchedPairTransformExtractMode::Default)
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEMatchedPairTransformExtractOptions& extractOpts = OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEChem::OEMolBase& probemol,
                                                                                             const OEMatchedPairTransformExtractOptions& extractOpts = OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEChem::OEMolBase& probemol,
                                                                                             const OEMatchedPairAnalyzerOptions& fragOpts,
                                                                                             const OEMatchedPairTransformExtractOptions& extractOpts = OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEChem::OEMolBase& probemol,
                                                                                             const OEChem::OEAtomBondSet& probesubst,
                                                                                             const OEMatchedPairTransformExtractOptions& extractOpts = OEMatchedPairTransformExtractOptions())
         OESystem::OEIterBase<OEMedChem::OEMatchedPairTransform>* OEMatchedPairGetTransforms(const OEMatchedPairAnalyzer& mmpindex,
                                                                                             const OEChem::OEMolBase& probemol,
                                                                                             const char* probesubstDataField,
                                                                                             const OEMatchedPairTransformExtractOptions& extractOpts = OEMatchedPairTransformExtractOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    context: int, extractMode: int) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    probemol: Union[OEGraphMol,OEMol,OEQMol],
                                    context: int, extractMode: int) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    probemol: Union[OEGraphMol,OEMol,OEQMol],
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    probemol: Union[OEGraphMol,OEMol,OEQMol],
                                    fragOpts: OEMatchedPairAnalyzerOptions,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    probemol: Union[OEGraphMol,OEMol,OEQMol],
                                    probesubst: OEAtomBondSet,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPairTransform]
         OEMatchedPairGetTransforms(mmpindex: OEMatchedPairAnalyzer,
                                    probemol: Union[OEGraphMol,OEMol,OEQMol],
                                    probesubstDataField: str,
                                    extractOpts: OEMatchedPairTransformExtractOptions = OEMatchedPairTransformExtractOptions()) -> Iterable[OEMatchedPairTransform]

   Given an analyzer containing indexed structures, retrieves the transformations derived from the discovered matched pair information.

   Overloaded functions support the ability to pass in an arbitrary structure and return related matched molecular
   pair transformations that share any of the identified substituents from the probe structure.  The probe molecule is
   not added to the index, it is only used to locate related transformations.  The probe molecule is subject to the same
   filtering constraints as the structures present in the index.  An additional overloaded function signature is provided that allows
   passing different fragmentation filtering constraints for the probe structure than the indexed structures to
   allow a more generalized extraction of transformations.

   The final two overloaded functions support the ability to pass in an arbitrary structure and return related matched molecular
   pair transformations at one or more identified attachment site(s) on the probe structure.

   The context argument controls the amount of chemistry context to include in the returned transforms.  The extract mode
   argument provides some control over the transformation string returned.  The extraction options object allows the most
   control over the content of the extracted transformations.

   .. seealso::

      * :oe:func:`OEMedChem::OEGetMatchedMolecularPairs` function
      * :oe:constns:`OEMedChem::OEMatchedPairContext`
      * :oe:constns:`OEMedChem::OEMatchedPairTransformExtractMode`
      * :ref:`OEMatchedPairTransformExtractOptions <OEMedChem_OEMatchedPairTransformExtractOptions>`
      * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>`
      * :ref:`OEMatchedPairTransform <OEMedChem_OEMatchedPairTransform>`
      * :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>`
