.. _section_example_oechem_ringsubset:

Extract rings
================================================================================

A program that removes all non-ring atoms from the input molecules. By
default double bonded atoms exo to a ring are included as ring
atoms. This can be changed by using the flag ``-exo``. The program
will output the molecules to stdout as SMILES if no output file is
set. The molecule name will be appended with "_rings".

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

.. oe:language:: c++

   .. code-block:: console

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

.. oe:language:: python

   .. code-block:: console

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

.. oe:language:: java

   .. code-block:: console

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

.. oe:language:: csharp

   .. code-block:: console

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


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

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

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

   .. only:: oepdf

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

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

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

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

   .. only:: oepdf

      .. oe:source:: ringsubset.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

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

   .. only:: oepdf

      .. oe:source:: RingSubset.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

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

   .. only:: oepdf

      .. oe:source:: RingSubset.cs
         :language: csharp

.. seealso::

   * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>` functor
   * :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor
