.. _oemedchem_examples_matchedpairtransformprobe:

Matched Pair analysis and listing of transformations related to probe structures
================================================================================

A program that loads a previously generated Matched Pair index,
then prints the transformations and matched pairs found from the analysis that are
related to the provided probe structure(s). 
If an (optional, numeric) data field is provided, the returned transformations can also
be ranked by the largest increase in the delta property found from the matched pairs that
define it.

.. seealso::

   * :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` class
   * :ref:`OEMatchedPairAnalyzerOptions <OEMedChem_OEMatchedPairAnalyzerOptions>` class
   * :oe:func:`OEMedChem::OEMatchedPairGetTransforms` function

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

.. oe:language:: c++

   .. code-block:: console

      prompt> MatchedPairTransformProbe [ -datafield sdDataField ] index.mmpidx probe_molecules.sdf

.. oe:language:: python

   .. code-block:: console

      prompt> MatchedPairTransformProbe.py [ -datafield sdDataField ] index.mmpidx probe_molecules.sdf

.. oe:language:: java

   .. code-block:: console

      prompt> MatchedPairTransformProbe [ -datafield sdDataField ] index.mmpidx probe_molecules.sdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> MatchedPairTransformProbe [ -datafield sdDataField ] index.mmpidx probe_molecules.sdf

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

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformProbe.cpp <../../../../sublibs/tklibs/medchem/examples/MatchedPairTransformProbe.cpp>`

   .. only:: oepdf

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

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformProbe.py <../../../../wrappers/python/examples/medchem/MatchedPairTransformProbe.py>`

   ..   literalinclude:: ../../../../wrappers/python/examples/medchem/MatchedPairTransformProbe.py

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformProbe.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformProbe.java <../../../../wrappers/java/examples/openeye/examples/oemedchem/MatchedPairTransformProbe.java>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformProbe.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MatchedPairTransformProbe.cs <../../../../wrappers/csharp/Csharp-Examples/OEMedChem/MatchedPairTransformProbe.cs>`

   .. only:: oepdf

      .. oe:source:: MatchedPairTransformProbe.cs
         :language: csharp

