.. _section_example_oechem_extractscaffold:

Extract molecule scaffolds
================================================================================

This example is a program that removes all atoms that are neither ring atoms nor atoms in
linkers between rings. By default, double bonded atoms exo to a ring
are included as ring atoms. This can be changed by using the flag ``-exo``.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> extractscaffold dbase.oeb.gz
      prompt> extractscaffold -exo false -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> extractscaffold.py dbase.oeb.gz
      prompt> extractscaffold.py -exo false -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> ExtractScaffold dbase.oeb.gz
      prompt> ExtractScaffold -exo false -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> ExtractScaffold dbase.oeb.gz
      prompt> ExtractScaffold -exo false -i dbase.oeb.gz -o output.oeb.gz

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

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extractscaffold.cpp <../../../../../sublibs/tklibs/oechem/examples/extractscaffold.cpp>`

   .. only:: oepdf

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

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`extractscaffold.py <../../../../../wrappers/python/examples/oechem/extractscaffold.py>`

      .. literalinclude:: ../../../../../wrappers/python/examples/oechem/extractscaffold.py


   .. only:: oepdf

      .. oe:source:: extractscaffold.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExtractScaffold.java <../../../../../wrappers/java/examples/openeye/examples/oechem/ExtractScaffold.java>`

   .. only:: oepdf

      .. oe:source:: ExtractScaffold.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ExtractScaffold.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/ExtractScaffold.cs>`

   .. only:: oepdf

      .. oe:source:: ExtractScaffold.cs
         :language: csharp

.. seealso::

   * :oe:func:`OEChem::OESubsetMol` function
   * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>` functor
   * :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor
